MagickCore  6.9.11-60
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
40 
41  char
42  *name;
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
64  *GetStringInfoPath(const StringInfo *);
65 
66 extern MagickExport double
68  *StringToArrayOfDoubles(const char *,ssize_t *, ExceptionInfo *);
69 
70 extern MagickExport int
71  CompareStringInfo(const StringInfo *,const StringInfo *);
72 
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
81  const size_t) magick_attribute((__nonnull__)),
83  const size_t) magick_attribute((__nonnull__)),
85 
86 extern MagickExport ssize_t
88 
90  *AcquireStringInfo(const size_t),
91  *BlobToStringInfo(const void *,const size_t),
93  *ConfigureFileToStringInfo(const char *),
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
104  magick_attribute((__nonnull__)),
105  PrintStringInfo(FILE *file,const char *,const StringInfo *),
108  SetStringInfoDatum(StringInfo *,const unsigned char *),
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 MagickBooleanType magick_attribute((deprecated))
size_t MagickSizeType
Definition: magick-type.h:140
MagickBooleanType
Definition: magick-type.h:203
#define MagickExport
Definition: method-attribute.h:80
#define MaxTextExtent
Definition: method-attribute.h:89
MagickExport void SetStringInfoDatum(StringInfo *, const unsigned char *)
MagickExport const char * GetStringInfoPath(const StringInfo *)
Definition: string.c:1270
MagickExport const char * GetStringInfoName(const StringInfo *)
MagickExport MagickBooleanType ConcatenateString(char **magick_restrict, const char *magick_restrict)
MagickExport void ConcatenateStringInfo(StringInfo *, const StringInfo *) magick_attribute((__nonnull__))
MagickExport StringInfo * FileToStringInfo(const char *, const size_t, ExceptionInfo *)
MagickExport char ** DestroyStringList(char **)
MagickExport size_t ConcatenateMagickString(char *magick_restrict, const char *magick_restrict, const size_t) magick_attribute((__nonnull__))
MagickExport StringInfo * ConfigureFileToStringInfo(const char *)
MagickExport double * StringToArrayOfDoubles(const char *, ssize_t *, ExceptionInfo *)
Definition: string.c:2104
MagickExport void SetStringInfoPath(StringInfo *, const char *)
MagickExport char * SanitizeString(const char *)
MagickExport char ** StringToArgv(const char *, int *)
MagickExport StringInfo * StringToStringInfo(const char *)
Definition: string.c:2446
MagickExport char * DestroyString(char *)
MagickExport void SetStringInfoLength(StringInfo *, const size_t)
MagickExport char * GetEnvironmentValue(const char *)
MagickExport char * FileToString(const char *, const size_t, ExceptionInfo *)
MagickExport ssize_t FormatMagickSize(const MagickSizeType, const MagickBooleanType, char *)
Definition: string.c:1070
MagickExport char * ConstantString(const char *)
MagickExport MagickBooleanType IsStringNotFalse(const char *) magick_attribute((__pure__))
MagickExport char * StringInfoToHexString(const StringInfo *)
MagickExport int CompareStringInfo(const StringInfo *, const StringInfo *)
Definition: string.c:377
MagickExport void ResetStringInfo(StringInfo *)
MagickExport void SetStringInfo(StringInfo *, const StringInfo *)
MagickExport void SetStringInfoName(StringInfo *, const char *)
MagickExport size_t CopyMagickString(char *magick_restrict, const char *magick_restrict, const size_t) magick_attribute((__nonnull__))
MagickExport MagickBooleanType SubstituteString(char **, const char *, const char *)
Definition: string.c:2542
MagickExport void PrintStringInfo(FILE *file, const char *, const StringInfo *)
MagickExport char * AcquireString(const char *)
MagickExport StringInfo * DestroyStringInfo(StringInfo *)
MagickExport StringInfo * CloneStringInfo(const StringInfo *)
MagickExport char * EscapeString(const char *, const char)
MagickExport char * StringInfoToString(const StringInfo *)
MagickExport char ** StringToList(const char *)
MagickExport MagickBooleanType IsStringTrue(const char *) magick_attribute((__pure__))
struct _StringInfo StringInfo
MagickExport char * StringToken(const char *, char **)
MagickExport StringInfo * AcquireStringInfo(const size_t)
MagickExport unsigned char * GetStringInfoDatum(const StringInfo *)
Definition: string.c:1183
MagickExport StringInfo * BlobToStringInfo(const void *, const size_t)
MagickExport double InterpretSiPrefixValue(const char *magick_restrict, char **magick_restrict)
MagickExport void StripString(char *)
Definition: string.c:2480
MagickExport StringInfo * SplitStringInfo(StringInfo *, const size_t)
MagickExport char * CloneString(char **, const char *)
MagickExport char ** StringToStrings(const char *, size_t *)
Definition: string.c:2297
MagickExport size_t GetStringInfoLength(const StringInfo *)
Definition: string.c:1212
Definition: exception.h:103
Definition: string_.h:30
size_t length
Definition: string_.h:38
char path[MaxTextExtent]
Definition: string_.h:32
size_t signature
Definition: string_.h:39
unsigned char * datum
Definition: string_.h:35
char * name
Definition: string_.h:42