MagickCore  6.9.10
Convert, Edit, Or Compose Bitmap Images
string_.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2020 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 
61 extern MagickExport const char
62  *GetStringInfoName(const StringInfo *),
63  *GetStringInfoPath(const StringInfo *);
64 
65 extern MagickExport double
66  InterpretSiPrefixValue(const char *magick_restrict,char **magick_restrict),
67  *StringToArrayOfDoubles(const char *,ssize_t *, ExceptionInfo *);
68 
69 extern MagickExport int
70  CompareStringInfo(const StringInfo *,const StringInfo *);
71 
73  ConcatenateString(char **magick_restrict,const char *magick_restrict),
74  IsStringTrue(const char *) magick_attribute((__pure__)),
75  IsStringNotFalse(const char *) magick_attribute((__pure__)),
76  SubstituteString(char **,const char *,const char *);
77 
78 extern MagickExport size_t
79  ConcatenateMagickString(char *magick_restrict,const char *magick_restrict,
80  const size_t) magick_attribute((__nonnull__)),
81  CopyMagickString(char *magick_restrict,const char *magick_restrict,
82  const size_t) magick_attribute((__nonnull__)),
84 
85 extern MagickExport ssize_t
87 
88 extern MagickExport StringInfo
89  *AcquireStringInfo(const size_t),
90  *BlobToStringInfo(const void *,const size_t),
91  *CloneStringInfo(const StringInfo *),
92  *ConfigureFileToStringInfo(const char *),
93  *DestroyStringInfo(StringInfo *),
94  *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
95  *SplitStringInfo(StringInfo *,const size_t),
96  *StringToStringInfo(const char *);
97 
98 extern MagickExport unsigned char
99  *GetStringInfoDatum(const StringInfo *);
100 
101 extern MagickExport void
102  ConcatenateStringInfo(StringInfo *,const StringInfo *)
103  magick_attribute((__nonnull__)),
104  PrintStringInfo(FILE *file,const char *,const StringInfo *),
105  ResetStringInfo(StringInfo *),
106  SetStringInfo(StringInfo *,const StringInfo *),
107  SetStringInfoDatum(StringInfo *,const unsigned char *),
108  SetStringInfoLength(StringInfo *,const size_t),
109  SetStringInfoName(StringInfo *,const char *),
110  SetStringInfoPath(StringInfo *,const char *),
111  StripString(char *);
112 
113 #if defined(__cplusplus) || defined(c_plusplus)
114 }
115 #endif
116 
117 #endif
#define magick_restrict
Definition: MagickCore.h:41
MagickExport double InterpretSiPrefixValue(const char *magick_restrict string, char **magick_restrict sentinal)
Definition: string.c:1316
MagickExport int CompareStringInfo(const StringInfo *target, const StringInfo *source)
Definition: string.c:376
MagickExport StringInfo * StringToStringInfo(const char *string)
Definition: string.c:2421
MagickExport size_t ConcatenateMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:424
MagickExport void SetStringInfoPath(StringInfo *string_info, const char *path)
Definition: string.c:1802
Definition: exception.h:102
unsigned char * datum
Definition: string_.h:35
MagickExport char * EscapeString(const char *source, const char escape)
Definition: string.c:924
MagickExport char * SanitizeString(const char *source)
Definition: string.c:1605
MagickExport void ConcatenateStringInfo(StringInfo *string_info, const StringInfo *source)
Definition: string.c:550
MagickExport size_t CopyMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:752
MagickExport void StripString(char *message)
Definition: string.c:2455
MagickExport char * FileToString(const char *filename, const size_t extent, ExceptionInfo *exception)
Definition: string.c:995
Definition: string_.h:29
MagickExport unsigned char * GetStringInfoDatum(const StringInfo *string_info)
Definition: string.c:1195
MagickBooleanType
Definition: magick-type.h:198
MagickExport char ** StringToList(const char *text)
Definition: string.c:2278
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:1033
MagickExport StringInfo * DestroyStringInfo(StringInfo *string_info)
Definition: string.c:847
MagickExport void ResetStringInfo(StringInfo *string_info)
Definition: string.c:1573
#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:1489
MagickExport MagickBooleanType IsStringTrue(const char *value)
Definition: string.c:1405
MagickExport MagickBooleanType IsStringNotFalse(const char *value)
Definition: string.c:1447
MagickExport StringInfo * BlobToStringInfo(const void *blob, const size_t length)
Definition: string.c:227
MagickExport double * StringToArrayOfDoubles(const char *string, ssize_t *count, ExceptionInfo *exception)
Definition: string.c:2116
MagickExport MagickBooleanType SubstituteString(char **string, const char *search, const char *replace)
Definition: string.c:2517
MagickExport char * GetEnvironmentValue(const char *name)
Definition: string.c:1162
MagickExport StringInfo * ConfigureFileToStringInfo(const char *filename)
Definition: string.c:590
MagickExport StringInfo * AcquireStringInfo(const size_t length)
Definition: string.c:185
char path[MaxTextExtent]
Definition: string_.h:32
MagickExport const char * GetStringInfoPath(const StringInfo *string_info)
Definition: string.c:1282
MagickExport void SetStringInfoName(StringInfo *string_info, const char *name)
Definition: string.c:1770
MagickExport char * StringToken(const char *delimiters, char **string)
Definition: string.c:2215
MagickExport void SetStringInfoLength(StringInfo *string_info, const size_t length)
Definition: string.c:1726
MagickExport char * DestroyString(char *string)
Definition: string.c:820
char * name
Definition: string_.h:42
MagickExport char ** DestroyStringList(char **list)
Definition: string.c:883
struct _StringInfo StringInfo
MagickExport ssize_t FormatMagickSize(const MagickSizeType size, const MagickBooleanType bi, char *format)
Definition: string.c:1082
MagickExport MagickBooleanType ConcatenateString(char **magick_restrict destination, const char *magick_restrict source)
Definition: string.c:490
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:284
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:1832
MagickExport char * StringInfoToString(const StringInfo *string_info)
Definition: string.c:1872
MagickExport char * StringInfoToHexString(const StringInfo *string_info)
Definition: string.c:1913
MagickExport char ** StringToArgv(const char *text, int *argc)
Definition: string.c:2001
MagickExport size_t GetStringInfoLength(const StringInfo *string_info)
Definition: string.c:1224
MagickExport const char * GetStringInfoName(const StringInfo *string_info)
Definition: string.c:1253
MagickExport char * ConstantString(const char *source)
Definition: string.c:697
MagickExport StringInfo * CloneStringInfo(const StringInfo *string_info)
Definition: string.c:336
MagickExport void SetStringInfoDatum(StringInfo *string_info, const unsigned char *source)
Definition: string.c:1693
MagickExport void SetStringInfo(StringInfo *string_info, const StringInfo *source)
Definition: string.c:1653