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
32     path[MaxTextExtent];
33 
34   unsigned char
35     *datum;
36 
37   size_t
38     length,
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 *),
55   *StringInfoToHexString(const StringInfo *),
56   *StringInfoToString(const StringInfo *),
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 
73 extern MagickExport MagickBooleanType
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__)),
84   GetStringInfoLength(const StringInfo *);
85 
86 extern MagickExport ssize_t
87   FormatMagickSize(const MagickSizeType,const MagickBooleanType,char *);
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
119