MagickCore  6.9.12-3
Convert, Edit, Or Compose Bitmap Images
string_.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2021 ImageMagick Studio LLC, a non-profit organization
3  dedicated to making software imaging solutions freely available.
4 
5  You may not use this file except in compliance with the License. You may
6  obtain a copy of the License at
7 
8  https://imagemagick.org/script/license.php
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 
16  MagickCore string methods.
17 */
18 #ifndef MAGICKCORE_STRING_H_
19 #define MAGICKCORE_STRING_H_
20 
21 #include <stdarg.h>
22 #include <time.h>
23 #include "magick/exception.h"
24 
25 #if defined(__cplusplus) || defined(c_plusplus)
26 extern "C" {
27 #endif
28 
29 typedef struct _StringInfo
30 {
31  char
33 
34  unsigned char
36 
37  size_t
39  signature;
40 
41  char
42  *name;
43 } StringInfo;
44 
45 extern MagickExport char
46  *AcquireString(const char *),
47  *CloneString(char **,const char *),
48  *ConstantString(const char *),
49  *DestroyString(char *),
50  **DestroyStringList(char **),
51  *EscapeString(const char *,const char),
52  *FileToString(const char *,const size_t,ExceptionInfo *),
53  *GetEnvironmentValue(const char *),
54  *SanitizeString(const char *),
57  **StringToArgv(const char *,int *),
58  *StringToken(const char *,char **),
59  **StringToList(const char *),
60  **StringToStrings(const char *,size_t *);
61 
62 extern MagickExport const char
63  *GetStringInfoName(const StringInfo *),
64  *GetStringInfoPath(const StringInfo *);
65 
66 extern MagickExport double
67  InterpretSiPrefixValue(const char *magick_restrict,char **magick_restrict),
68  *StringToArrayOfDoubles(const char *,ssize_t *, ExceptionInfo *);
69 
70 extern MagickExport int
71  CompareStringInfo(const StringInfo *,const StringInfo *);
72 
74  ConcatenateString(char **magick_restrict,const char *magick_restrict),
75  IsStringTrue(const char *) magick_attribute((__pure__)),
76  IsStringNotFalse(const char *) magick_attribute((__pure__)),
77  SubstituteString(char **,const char *,const char *);
78 
79 extern MagickExport size_t
80  ConcatenateMagickString(char *magick_restrict,const char *magick_restrict,
81  const size_t) magick_attribute((__nonnull__)),
82  CopyMagickString(char *magick_restrict,const char *magick_restrict,
83  const size_t) magick_attribute((__nonnull__)),
85 
86 extern MagickExport ssize_t
88 
89 extern MagickExport StringInfo
90  *AcquireStringInfo(const size_t),
91  *BlobToStringInfo(const void *,const size_t),
92  *CloneStringInfo(const StringInfo *),
93  *ConfigureFileToStringInfo(const char *),
94  *DestroyStringInfo(StringInfo *),
95  *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
96  *SplitStringInfo(StringInfo *,const size_t),
97  *StringToStringInfo(const char *);
98 
99 extern MagickExport unsigned char
100  *GetStringInfoDatum(const StringInfo *);
101 
102 extern MagickExport void
103  ConcatenateStringInfo(StringInfo *,const StringInfo *)
104  magick_attribute((__nonnull__)),
105  PrintStringInfo(FILE *file,const char *,const StringInfo *),
106  ResetStringInfo(StringInfo *),
107  SetStringInfo(StringInfo *,const StringInfo *),
108  SetStringInfoDatum(StringInfo *,const unsigned char *),
109  SetStringInfoLength(StringInfo *,const size_t),
110  SetStringInfoName(StringInfo *,const char *),
111  SetStringInfoPath(StringInfo *,const char *),
112  StripString(char *);
113 
114 #if defined(__cplusplus) || defined(c_plusplus)
115 }
116 #endif
117 
118 #endif
#define magick_restrict
Definition: MagickCore.h:41
MagickExport double InterpretSiPrefixValue(const char *magick_restrict string, char **magick_restrict sentinal)
Definition: string.c:1304
MagickExport int CompareStringInfo(const StringInfo *target, const StringInfo *source)
Definition: string.c:377
MagickExport StringInfo * StringToStringInfo(const char *string)
Definition: string.c:2446
MagickExport size_t ConcatenateMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:425
MagickExport void SetStringInfoPath(StringInfo *string_info, const char *path)
Definition: string.c:1790
Definition: exception.h:102
unsigned char * datum
Definition: string_.h:35
MagickExport char * EscapeString(const char *source, const char escape)
Definition: string.c:912
MagickExport char * SanitizeString(const char *source)
Definition: string.c:1593
MagickExport void ConcatenateStringInfo(StringInfo *string_info, const StringInfo *source)
Definition: string.c:551
MagickExport size_t CopyMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:751
MagickExport void StripString(char *message)
Definition: string.c:2480
MagickExport char * FileToString(const char *filename, const size_t extent, ExceptionInfo *exception)
Definition: string.c:983
Definition: string_.h:29
MagickExport unsigned char * GetStringInfoDatum(const StringInfo *string_info)
Definition: string.c:1183
MagickBooleanType
Definition: magick-type.h:198
MagickExport char ** StringToList(const char *text)
Definition: string.c:2266
MagickExport char * AcquireString(const char *source)
Definition: string.c:125
MagickExport StringInfo * FileToStringInfo(const char *filename, const size_t extent, ExceptionInfo *exception)
Definition: string.c:1021
MagickExport StringInfo * DestroyStringInfo(StringInfo *string_info)
Definition: string.c:835
MagickExport void ResetStringInfo(StringInfo *string_info)
Definition: string.c:1561
#define MaxTextExtent
Definition: method-attribute.h:89
size_t MagickSizeType
Definition: magick-type.h:136
MagickExport void PrintStringInfo(FILE *file, const char *id, const StringInfo *string_info)
Definition: string.c:1477
MagickExport MagickBooleanType IsStringTrue(const char *value)
Definition: string.c:1393
MagickExport MagickBooleanType IsStringNotFalse(const char *value)
Definition: string.c:1435
MagickExport StringInfo * BlobToStringInfo(const void *blob, const size_t length)
Definition: string.c:226
MagickExport double * StringToArrayOfDoubles(const char *string, ssize_t *count, ExceptionInfo *exception)
Definition: string.c:2104
MagickExport MagickBooleanType SubstituteString(char **string, const char *search, const char *replace)
Definition: string.c:2542
MagickExport char * GetEnvironmentValue(const char *name)
Definition: string.c:1150
MagickExport StringInfo * ConfigureFileToStringInfo(const char *filename)
Definition: string.c:591
MagickExport StringInfo * AcquireStringInfo(const size_t length)
Definition: string.c:184
char path[MaxTextExtent]
Definition: string_.h:32
MagickExport const char * GetStringInfoPath(const StringInfo *string_info)
Definition: string.c:1270
MagickExport void SetStringInfoName(StringInfo *string_info, const char *name)
Definition: string.c:1758
MagickExport char * StringToken(const char *delimiters, char **string)
Definition: string.c:2203
MagickExport void SetStringInfoLength(StringInfo *string_info, const size_t length)
Definition: string.c:1714
MagickExport char * DestroyString(char *string)
Definition: string.c:808
char * name
Definition: string_.h:42
MagickExport char ** DestroyStringList(char **list)
Definition: string.c:871
struct _StringInfo StringInfo
MagickExport ssize_t FormatMagickSize(const MagickSizeType size, const MagickBooleanType bi, char *format)
Definition: string.c:1070
MagickExport MagickBooleanType ConcatenateString(char **magick_restrict destination, const char *magick_restrict source)
Definition: string.c:491
size_t signature
Definition: string_.h:38
#define magick_attribute(x)
Definition: deprecate.h:41
MagickExport char * CloneString(char **destination, const char *source)
Definition: string.c:283
MagickExport char ** StringToStrings(const char *text, size_t *count)
Definition: string.c:2297
size_t length
Definition: string_.h:38
#define MagickExport
Definition: method-attribute.h:80
MagickExport StringInfo * SplitStringInfo(StringInfo *string_info, const size_t offset)
Definition: string.c:1820
MagickExport char * StringInfoToString(const StringInfo *string_info)
Definition: string.c:1860
MagickExport char * StringInfoToHexString(const StringInfo *string_info)
Definition: string.c:1901
MagickExport char ** StringToArgv(const char *text, int *argc)
Definition: string.c:1989
MagickExport size_t GetStringInfoLength(const StringInfo *string_info)
Definition: string.c:1212
MagickExport const char * GetStringInfoName(const StringInfo *string_info)
Definition: string.c:1241
MagickExport char * ConstantString(const char *source)
Definition: string.c:698
MagickExport StringInfo * CloneStringInfo(const StringInfo *string_info)
Definition: string.c:335
MagickExport void SetStringInfoDatum(StringInfo *string_info, const unsigned char *source)
Definition: string.c:1681
MagickExport void SetStringInfo(StringInfo *string_info, const StringInfo *source)
Definition: string.c:1641