use 'convert' as more precise term than 'cast' for the conversion from sstr_t to scstr_t

Wed, 16 May 2018 19:01:21 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 16 May 2018 19:01:21 +0200
changeset 320
0ffb71f15426
parent 319
0380e438a7ce
child 321
9af21a50b516

use 'convert' as more precise term than 'cast' for the conversion from sstr_t to scstr_t

src/ucx/string.h file | annotate | diff | comparison | revisions
     1.1 --- a/src/ucx/string.h	Wed May 16 18:56:44 2018 +0200
     1.2 +++ b/src/ucx/string.h	Wed May 16 19:01:21 2018 +0200
     1.3 @@ -110,7 +110,7 @@
     1.4  /**
     1.5   * One of two type adjustment functions that return a scstr_t.
     1.6   * 
     1.7 - * Used internally to cast a UCX string to an immutable UCX string.
     1.8 + * Used internally to convert a UCX string to an immutable UCX string.
     1.9   * This variant is used, when the string is already immutable and no operation
    1.10   * needs to be performed.
    1.11   * 
    1.12 @@ -122,7 +122,7 @@
    1.13  /**
    1.14   * One of two type adjustment functions that return a scstr_t.
    1.15   * 
    1.16 - * Used internally to cast a UCX string to an immutable UCX string.
    1.17 + * Used internally to convert a UCX string to an immutable UCX string.
    1.18   * 
    1.19   * @param str some sstr_t
    1.20   * @return an immutable (scstr_t) version of the provided string.
    1.21 @@ -167,7 +167,7 @@
    1.22   * Casts a UCX string to an immutable UCX string (scstr_t).
    1.23   * 
    1.24   * This internal function (ab)uses the C standard an expects one single
    1.25 - * argument which is then implicitly casted to scstr_t without a warning.
    1.26 + * argument which is then implicitly converted to scstr_t without a warning.
    1.27   * 
    1.28   * @return the an immutable version of the provided string
    1.29   */
    1.30 @@ -266,7 +266,7 @@
    1.31  size_t scstrnlen(size_t count, ...);
    1.32  
    1.33  /**
    1.34 - * Alias for scstrnlen() which automatically casts the arguments.
    1.35 + * Alias for scstrnlen() which automatically converts the arguments.
    1.36   * 
    1.37   * @param count    the total number of specified strings (so at least 1)
    1.38   * @param ...      all strings
    1.39 @@ -291,7 +291,7 @@
    1.40  sstr_t scstrcat(size_t count, scstr_t s1, ...);
    1.41  
    1.42  /**
    1.43 - * Alias for scstrcat() which automatically casts the arguments.
    1.44 + * Alias for scstrcat() which automatically converts the arguments.
    1.45   * 
    1.46   * @param count   the total number of strings to concatenate
    1.47   * @param s1      first string
    1.48 @@ -314,7 +314,7 @@
    1.49  sstr_t scstrcat_a(UcxAllocator *a, size_t count, scstr_t s1, ...);
    1.50  
    1.51  /**
    1.52 - * Alias for scstrcat_a() which automatically casts the arguments.
    1.53 + * Alias for scstrcat_a() which automatically converts the arguments.
    1.54   * 
    1.55   * See sstrcat() for details.
    1.56   *
    1.57 @@ -471,7 +471,7 @@
    1.58  sstr_t scstrsstr(sstr_t string, scstr_t match);
    1.59  
    1.60  /**
    1.61 - * Alias for scstrsstr() which automatically casts the match string.
    1.62 + * Alias for scstrsstr() which automatically converts the match string.
    1.63   * 
    1.64   * @param string the string to be scanned
    1.65   * @param match  string containing the sequence of characters to match
    1.66 @@ -499,7 +499,7 @@
    1.67  scstr_t scstrscstr(scstr_t string, scstr_t match);
    1.68  
    1.69  /**
    1.70 - * Alias for scstrscstr() which automatically casts the match string.
    1.71 + * Alias for scstrscstr() which automatically converts the match string.
    1.72   * 
    1.73   * @param string the string to be scanned
    1.74   * @param match  string containing the sequence of characters to match
    1.75 @@ -559,7 +559,7 @@
    1.76  sstr_t* scstrsplit(scstr_t string, scstr_t delim, ssize_t *count);
    1.77  
    1.78  /**
    1.79 - * Alias for scstrsplit() which automatically casts the arguments.
    1.80 + * Alias for scstrsplit() which automatically converts the arguments.
    1.81   * 
    1.82   * @param string the string to split
    1.83   * @param delim  the delimiter string
    1.84 @@ -599,7 +599,7 @@
    1.85          ssize_t *count);
    1.86  
    1.87  /**
    1.88 - * Alias for scstrsplit_a() which automatically casts the arguments.
    1.89 + * Alias for scstrsplit_a() which automatically converts the arguments.
    1.90   * 
    1.91   * @param allocator the UcxAllocator used for allocating memory
    1.92   * @param string the string to split
    1.93 @@ -629,7 +629,7 @@
    1.94  int scstrcmp(scstr_t s1, scstr_t s2);
    1.95  
    1.96  /**
    1.97 - * Alias for scstrcmp() which automatically casts its arguments.
    1.98 + * Alias for scstrcmp() which automatically converts its arguments.
    1.99   * 
   1.100   * @param s1 the first string
   1.101   * @param s2 the second string
   1.102 @@ -655,7 +655,7 @@
   1.103  int scstrcasecmp(scstr_t s1, scstr_t s2);
   1.104  
   1.105  /**
   1.106 - * Alias for scstrcasecmp() which automatically casts the arguments.
   1.107 + * Alias for scstrcasecmp() which automatically converts the arguments.
   1.108   * 
   1.109   * @param s1 the first string
   1.110   * @param s2 the second string
   1.111 @@ -682,7 +682,7 @@
   1.112  sstr_t scstrdup(scstr_t string);
   1.113  
   1.114  /**
   1.115 - * Alias for scstrdup() which automatically casts the argument.
   1.116 + * Alias for scstrdup() which automatically converts the argument.
   1.117   * 
   1.118   * @param string the string to duplicate
   1.119   * @return a duplicate of the string
   1.120 @@ -709,7 +709,7 @@
   1.121  sstr_t scstrdup_a(UcxAllocator *allocator, scstr_t string);
   1.122  
   1.123  /**
   1.124 - * Alias for scstrdup_a() which automatically casts the argument.
   1.125 + * Alias for scstrdup_a() which automatically converts the argument.
   1.126   * 
   1.127   * @param allocator a valid instance of a UcxAllocator
   1.128   * @param string the string to duplicate
   1.129 @@ -766,7 +766,7 @@
   1.130  int scstrprefix(scstr_t string, scstr_t prefix);
   1.131  
   1.132  /**
   1.133 - * Alias for scstrprefix() which automatically casts the arguments.
   1.134 + * Alias for scstrprefix() which automatically converts the arguments.
   1.135   * 
   1.136   * @param string the string to check
   1.137   * @param prefix the prefix the string should have
   1.138 @@ -783,7 +783,7 @@
   1.139  int scstrsuffix(scstr_t string, scstr_t suffix);
   1.140  
   1.141  /**
   1.142 - * Alias for scstrsuffix() which automatically casts the arguments.
   1.143 + * Alias for scstrsuffix() which automatically converts the arguments.
   1.144   *
   1.145   * @param string the string to check
   1.146   * @param suffix the suffix the string should have
   1.147 @@ -804,7 +804,7 @@
   1.148  sstr_t scstrlower(scstr_t string);
   1.149  
   1.150  /**
   1.151 - * Alias for scstrlower() which automatically casts the argument.
   1.152 + * Alias for scstrlower() which automatically converts the argument.
   1.153   * 
   1.154   * @param string the input string
   1.155   * @return the resulting lower case string
   1.156 @@ -826,7 +826,7 @@
   1.157  
   1.158  
   1.159  /**
   1.160 - * Alias for scstrlower_a() which automatically casts the argument.
   1.161 + * Alias for scstrlower_a() which automatically converts the argument.
   1.162   * 
   1.163   * @param allocator the allocator used for duplicating the string
   1.164   * @param string the input string
   1.165 @@ -847,7 +847,7 @@
   1.166  sstr_t scstrupper(scstr_t string);
   1.167  
   1.168  /**
   1.169 - * Alias for scstrupper() which automatically casts the argument.
   1.170 + * Alias for scstrupper() which automatically converts the argument.
   1.171   * 
   1.172   * @param string the input string
   1.173   * @return the resulting upper case string
   1.174 @@ -868,7 +868,7 @@
   1.175  sstr_t scstrupper_a(UcxAllocator *allocator, scstr_t string);
   1.176  
   1.177  /**
   1.178 - * Alias for scstrupper_a() which automatically casts the argument.
   1.179 + * Alias for scstrupper_a() which automatically converts the argument.
   1.180   * 
   1.181   * @param allocator the allocator used for duplicating the string
   1.182   * @param string the input string

mercurial