MagickCore  6.9.10
Convert, Edit, Or Compose Bitmap Images
string_.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2019 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.
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 
61 extern MagickExport const char
63  *GetStringInfoPath(const StringInfo *);
64 
65 extern MagickExport double
67  *StringToArrayOfDoubles(const char *,ssize_t *, ExceptionInfo *);
68 
69 extern MagickExport int
70  CompareStringInfo(const StringInfo *,const StringInfo *);
71 
73  ConcatenateString(char **,const char *),
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 *,const char *,const size_t)
80  magick_attribute((__nonnull__)),
81  CopyMagickString(char *,const char *,const size_t)
82  magick_attribute((__nonnull__)),
84 
85 extern MagickExport ssize_t
87  FormatMagickTime(const time_t,const size_t,char *);
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:196
#define MagickExport
Definition: method-attribute.h:80
#define MaxTextExtent
Definition: method-attribute.h:89
MagickExport void SetStringInfoDatum(StringInfo *, const unsigned char *)
MagickExport MagickBooleanType ConcatenateString(char **, const char *)
MagickExport const char * GetStringInfoPath(const StringInfo *)
Definition: string.c:1362
MagickExport const char * GetStringInfoName(const StringInfo *)
MagickExport void ConcatenateStringInfo(StringInfo *, const StringInfo *) magick_attribute((__nonnull__))
MagickExport StringInfo * FileToStringInfo(const char *, const size_t, ExceptionInfo *)
MagickExport char ** DestroyStringList(char **)
MagickExport StringInfo * ConfigureFileToStringInfo(const char *)
MagickExport double * StringToArrayOfDoubles(const char *, ssize_t *, ExceptionInfo *)
Definition: string.c:2196
MagickExport void SetStringInfoPath(StringInfo *, const char *)
MagickExport char * SanitizeString(const char *)
MagickExport char ** StringToArgv(const char *, int *)
MagickExport ssize_t FormatMagickTime(const time_t, const size_t, char *)
Definition: string.c:1168
MagickExport StringInfo * StringToStringInfo(const char *)
Definition: string.c:2497
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 *)
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:376
MagickExport void ResetStringInfo(StringInfo *)
MagickExport void SetStringInfo(StringInfo *, const StringInfo *)
MagickExport size_t CopyMagickString(char *, const char *, const size_t) magick_attribute((__nonnull__))
MagickExport void SetStringInfoName(StringInfo *, const char *)
MagickExport MagickBooleanType SubstituteString(char **, const char *, const char *)
Definition: string.c:2593
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 *)
Definition: string.c:2358
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:1275
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:2531
MagickExport StringInfo * SplitStringInfo(StringInfo *, const size_t)
MagickExport char * CloneString(char **, const char *)
MagickExport size_t ConcatenateMagickString(char *, const char *, const size_t) magick_attribute((__nonnull__))
MagickExport size_t GetStringInfoLength(const StringInfo *)
Definition: string.c:1304
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