luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-24 14:36:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the checkedmath SECTION

Browse Source 
Move it to a separate Markdown file.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-23 13:31:16 +00:00
parent b93e35dc17
commit 3957b47e59
4 changed files with 32 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/reference/glib/checked-math.md Normal file
View File

@ -0,0 +1,30 @@
Title: Bounds-checking Integer Arithmetic
SPDX-License-Identifier: LGPL-2.1-or-later
SPDX-FileCopyrightText: 2015 Allison Lortie
# Bounds-checking Integer Arithmetic
GLib offers a set of macros for doing additions and multiplications
of unsigned integers, with checks for overflows.
The helpers all have three arguments. A pointer to the destination
is always the first argument and the operands to the operation are
the other two.
Following standard GLib convention, the helpers return true in case
of success (ie: no overflow).
The helpers may be macros, normal functions or inlines. They may be
implemented with inline assembly or compiler intrinsics where
available.
Since: 2.48
The APIs are:
* [func@GLib.uint_checked_add]
* [func@GLib.uint_checked_mul]
* [func@GLib.uint64_checked_add]
* [func@GLib.uint64_checked_mul]
* [func@GLib.size_checked_add]
* [func@GLib.size_checked_mul]

1
docs/reference/glib/glib.toml.in
View File

@ -68,6 +68,7 @@ content_files = [
"reference-counting.md",
"testing.md",
"atomic.md",
"checked-math.md",
"threads.md",
"spawn.md",
"unix.md",

1
docs/reference/glib/meson.build
View File

@ -149,6 +149,7 @@ expand_content_files = [
'base64.md',
'building.md',
'character-set.md',
'checked-math.md',
'compiling.md',
'cross-compiling.md',
'datalist-and-dataset.md',

21
glib/docs.c
View File

@ -1702,27 +1702,6 @@
*/
/* Bounds-checked integer arithmetic {{{1 */
/**
* SECTION:checkedmath
* @title: Bounds-checking integer arithmetic
* @short_description: a set of helpers for performing checked integer arithmetic
*
* GLib offers a set of macros for doing additions and multiplications
* of unsigned integers, with checks for overflows.
*
* The helpers all have three arguments. A pointer to the destination
* is always the first argument and the operands to the operation are
* the other two.
*
* Following standard GLib convention, the helpers return %TRUE in case
* of success (ie: no overflow).
*
* The helpers may be macros, normal functions or inlines. They may be
* implemented with inline assembly or compiler intrinsics where
* available.
*
* Since: 2.48
*/
/**
* g_uint_checked_add