luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-21 06:39:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

gregex: Clarify units in documentation

Browse Source 
Make it a bit clearer that all lengths passed to GRegex methods are in
bytes (not characters). This is mentioned in the section overview, but
who reads that?

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=748620
This commit is contained in:
Philip Withnall 2018-04-23 12:01:27 +01:00
parent 9870de442f
commit fe35f577b0
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
glib/gregex.c
View File

@ -213,7 +213,7 @@ struct _GMatchInfo
gint *workspace; /* workspace for pcre_dfa_exec() */ gint *workspace; /* workspace for pcre_dfa_exec() */
gint n_workspace; /* number of workspace elements */ gint n_workspace; /* number of workspace elements */
const gchar *string; /* string passed to the match function */ const gchar *string; /* string passed to the match function */
gssize string_len; /* length of string */ gssize string_len; /* length of string, in bytes */
}; };
struct _GRegex struct _GRegex
@ -1719,7 +1719,7 @@ g_regex_match (const GRegex *regex,
* g_regex_match_full: * g_regex_match_full:
* @regex: a #GRegex structure from g_regex_new() * @regex: a #GRegex structure from g_regex_new()
* @string: (array length=string_len): the string to scan for matches * @string: (array length=string_len): the string to scan for matches
* @string_len: the length of @string, or -1 if @string is nul-terminated * @string_len: the length of @string, in bytes, or -1 if @string is nul-terminated
* @start_position: starting index of the string to match, in bytes * @start_position: starting index of the string to match, in bytes
* @match_options: match options * @match_options: match options
* @match_info: (out) (optional): pointer to location where to store * @match_info: (out) (optional): pointer to location where to store
@ -1850,7 +1850,7 @@ g_regex_match_all (const GRegex *regex,
* g_regex_match_all_full: * g_regex_match_all_full:
* @regex: a #GRegex structure from g_regex_new() * @regex: a #GRegex structure from g_regex_new()
* @string: (array length=string_len): the string to scan for matches * @string: (array length=string_len): the string to scan for matches
* @string_len: the length of @string, or -1 if @string is nul-terminated * @string_len: the length of @string, in bytes, or -1 if @string is nul-terminated
* @start_position: starting index of the string to match, in bytes * @start_position: starting index of the string to match, in bytes
* @match_options: match options * @match_options: match options
* @match_info: (out) (optional): pointer to location where to store * @match_info: (out) (optional): pointer to location where to store
@ -2123,7 +2123,7 @@ g_regex_split (const GRegex *regex,
* g_regex_split_full: * g_regex_split_full:
* @regex: a #GRegex structure * @regex: a #GRegex structure
* @string: (array length=string_len): the string to split with the pattern * @string: (array length=string_len): the string to split with the pattern
* @string_len: the length of @string, or -1 if @string is nul-terminated * @string_len: the length of @string, in bytes, or -1 if @string is nul-terminated
* @start_position: starting index of the string to match, in bytes * @start_position: starting index of the string to match, in bytes
* @match_options: match time option flags * @match_options: match time option flags
* @max_tokens: the maximum number of tokens to split @string into. * @max_tokens: the maximum number of tokens to split @string into.
@ -2752,7 +2752,7 @@ interpolation_list_needs_match (GList *list)
* g_regex_replace: * g_regex_replace:
* @regex: a #GRegex structure * @regex: a #GRegex structure
* @string: (array length=string_len): the string to perform matches against * @string: (array length=string_len): the string to perform matches against
* @string_len: the length of @string, or -1 if @string is nul-terminated * @string_len: the length of @string, in bytes, or -1 if @string is nul-terminated
* @start_position: starting index of the string to match, in bytes * @start_position: starting index of the string to match, in bytes
* @replacement: text to replace each match with * @replacement: text to replace each match with
* @match_options: options for the match * @match_options: options for the match
@ -2843,7 +2843,7 @@ literal_replacement (const GMatchInfo *match_info,
* g_regex_replace_literal: * g_regex_replace_literal:
* @regex: a #GRegex structure * @regex: a #GRegex structure
* @string: (array length=string_len): the string to perform matches against * @string: (array length=string_len): the string to perform matches against
* @string_len: the length of @string, or -1 if @string is nul-terminated * @string_len: the length of @string, in bytes, or -1 if @string is nul-terminated
* @start_position: starting index of the string to match, in bytes * @start_position: starting index of the string to match, in bytes
* @replacement: text to replace each match with * @replacement: text to replace each match with
* @match_options: options for the match * @match_options: options for the match
@ -2886,7 +2886,7 @@ g_regex_replace_literal (const GRegex *regex,
* g_regex_replace_eval: * g_regex_replace_eval:
* @regex: a #GRegex structure from g_regex_new() * @regex: a #GRegex structure from g_regex_new()
* @string: (array length=string_len): string to perform matches against * @string: (array length=string_len): string to perform matches against
* @string_len: the length of @string, or -1 if @string is nul-terminated * @string_len: the length of @string, in bytes, or -1 if @string is nul-terminated
* @start_position: starting index of the string to match, in bytes * @start_position: starting index of the string to match, in bytes
* @match_options: options for the match * @match_options: options for the match
* @eval: a function to call for each match * @eval: a function to call for each match
@ -3110,7 +3110,7 @@ g_regex_escape_nul (const gchar *string,
/** /**
* g_regex_escape_string: * g_regex_escape_string:
* @string: (array length=length): the string to escape * @string: (array length=length): the string to escape
* @length: the length of @string, or -1 if @string is nul-terminated * @length: the length of @string, in bytes, or -1 if @string is nul-terminated
* *
* Escapes the special characters used for regular expressions * Escapes the special characters used for regular expressions
* in @string, for instance "a.b*c" becomes "a\.b\*c". This * in @string, for instance "a.b*c" becomes "a\.b\*c". This