MagickCore  6.9.7
string_.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2017 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  http://www.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 } StringInfo;
41 
42 extern MagickExport char
43  *AcquireString(const char *),
44  *CloneString(char **,const char *),
45  *ConstantString(const char *),
46  *DestroyString(char *),
47  **DestroyStringList(char **),
48  *EscapeString(const char *,const char),
49  *FileToString(const char *,const size_t,ExceptionInfo *),
50  *GetEnvironmentValue(const char *),
51  *SanitizeString(const char *),
54  **StringToArgv(const char *,int *),
55  *StringToken(const char *,char **),
56  **StringToList(const char *);
57 
58 extern MagickExport const char
59  *GetStringInfoPath(const StringInfo *);
60 
61 extern MagickExport double
62  InterpretSiPrefixValue(const char *magick_restrict,char **magick_restrict),
63  *StringToArrayOfDoubles(const char *,ssize_t *, ExceptionInfo *);
64 
65 extern MagickExport int
66  CompareStringInfo(const StringInfo *,const StringInfo *);
67 
69  ConcatenateString(char **,const char *),
70  IsStringTrue(const char *),
71  IsStringNotFalse(const char *),
72  SubstituteString(char **,const char *,const char *);
73 
74 extern MagickExport size_t
75  ConcatenateMagickString(char *,const char *,const size_t)
76  magick_attribute((__nonnull__)),
77  CopyMagickString(char *,const char *,const size_t)
78  magick_attribute((__nonnull__)),
80 
81 extern MagickExport ssize_t
83  FormatMagickTime(const time_t,const size_t,char *);
84 
86  *AcquireStringInfo(const size_t),
87  *BlobToStringInfo(const void *,const size_t),
88  *CloneStringInfo(const StringInfo *),
89  *ConfigureFileToStringInfo(const char *),
91  *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
92  *SplitStringInfo(StringInfo *,const size_t),
93  *StringToStringInfo(const char *);
94 
95 extern MagickExport unsigned char
97 
98 extern MagickExport void
100  magick_attribute((__nonnull__)),
101  PrintStringInfo(FILE *file,const char *,const StringInfo *),
104  SetStringInfoDatum(StringInfo *,const unsigned char *),
105  SetStringInfoLength(StringInfo *,const size_t),
106  SetStringInfoPath(StringInfo *,const char *),
107  StripString(char *);
108 
109 #if defined(__cplusplus) || defined(c_plusplus)
110 }
111 #endif
112 
113 #endif
#define magick_restrict
Definition: MagickCore.h:41
MagickExport char ** StringToList(const char *)
Definition: string.c:2277
MagickExport unsigned char * GetStringInfoDatum(const StringInfo *)
Definition: string.c:1257
Definition: exception.h:102
unsigned char * datum
Definition: string_.h:35
MagickExport double * StringToArrayOfDoubles(const char *, ssize_t *, ExceptionInfo *)
Definition: string.c:2117
MagickExport StringInfo * AcquireStringInfo(const size_t)
MagickExport MagickBooleanType IsStringTrue(const char *)
MagickExport char ** StringToArgv(const char *, int *)
MagickExport int CompareStringInfo(const StringInfo *, const StringInfo *)
Definition: string.c:360
MagickExport void SetStringInfoPath(StringInfo *, const char *)
MagickExport char * StringToken(const char *, char **)
MagickExport size_t ConcatenateMagickString(char *, const char *, const size_t) magick_attribute((__nonnull__))
MagickExport char * StringInfoToHexString(const StringInfo *)
MagickExport char * EscapeString(const char *, const char)
MagickExport char * SanitizeString(const char *)
Definition: string_.h:29
MagickExport void SetStringInfoDatum(StringInfo *, const unsigned char *)
MagickExport StringInfo * StringToStringInfo(const char *)
Definition: string.c:2412
MagickExport MagickBooleanType IsStringNotFalse(const char *)
MagickBooleanType
Definition: magick-type.h:211
MagickExport StringInfo * SplitStringInfo(StringInfo *, const size_t)
MagickExport void ResetStringInfo(StringInfo *)
MagickExport char * ConstantString(const char *)
#define MaxTextExtent
Definition: method-attribute.h:106
MagickExport char ** DestroyStringList(char **)
size_t MagickSizeType
Definition: magick-type.h:156
MagickExport size_t CopyMagickString(char *, const char *, const size_t) magick_attribute((__nonnull__))
MagickExport void ConcatenateStringInfo(StringInfo *, const StringInfo *) magick_attribute((__nonnull__))
MagickExport StringInfo * FileToStringInfo(const char *, const size_t, ExceptionInfo *)
MagickExport void SetStringInfoLength(StringInfo *, const size_t)
MagickExport ssize_t FormatMagickTime(const time_t, const size_t, char *)
Definition: string.c:1150
MagickExport ssize_t FormatMagickSize(const MagickSizeType, const MagickBooleanType, char *)
MagickExport StringInfo * DestroyStringInfo(StringInfo *)
MagickExport MagickBooleanType magick_attribute((deprecated))
MagickExport char * CloneString(char **, const char *)
char path[MaxTextExtent]
Definition: string_.h:32
MagickExport char * FileToString(const char *, const size_t, ExceptionInfo *)
MagickExport char * AcquireString(const char *)
MagickExport char * DestroyString(char *)
struct _StringInfo StringInfo
MagickExport StringInfo * BlobToStringInfo(const void *, const size_t)
MagickExport MagickBooleanType SubstituteString(char **, const char *, const char *)
Definition: string.c:2508
MagickExport void SetStringInfo(StringInfo *, const StringInfo *)
MagickExport char * StringInfoToString(const StringInfo *)
MagickExport size_t GetStringInfoLength(const StringInfo *)
Definition: string.c:1286
size_t signature
Definition: string_.h:38
size_t length
Definition: string_.h:38
#define MagickExport
Definition: method-attribute.h:98
MagickExport double InterpretSiPrefixValue(const char *magick_restrict, char **magick_restrict)
MagickExport StringInfo * ConfigureFileToStringInfo(const char *)
MagickExport void StripString(char *)
Definition: string.c:2446
MagickExport char * GetEnvironmentValue(const char *)
MagickExport StringInfo * CloneStringInfo(const StringInfo *)
MagickExport void PrintStringInfo(FILE *file, const char *, const StringInfo *)
MagickExport MagickBooleanType ConcatenateString(char **, const char *)
MagickExport const char * GetStringInfoPath(const StringInfo *)
Definition: string.c:1315