MagickCore  6.9.12-38
Convert, Edit, Or Compose Bitmap Images
utility.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 utility methods.
17 */
18 #ifndef MAGICKCORE_UTILITY_H
19 #define MAGICKCORE_UTILITY_H
20 
21 #if defined(__cplusplus) || defined(c_plusplus)
22 extern "C" {
23 #endif
24 
25 typedef enum
26 {
39 
40 extern MagickExport char
41  *Base64Encode(const unsigned char *,const size_t,size_t *),
42  **GetPathComponents(const char *,size_t *),
43  **ListFiles(const char *,const char *,size_t *);
44 
47  AcquireUniqueSymbolicLink(const char *,char *),
48  ExpandFilenames(int *,char ***),
49  GetPathAttributes(const char *,void *),
50  GetExecutionPath(char *,const size_t),
51  IsPathAccessible(const char *);
52 
53 extern MagickExport size_t
54  MultilineCensus(const char *) magick_attribute((__pure__));
55 
56 extern MagickExport ssize_t
57  GetMagickPageSize(void);
58 
59 extern MagickExport unsigned char
60  *Base64Decode(const char *, size_t *);
61 
62 extern MagickExport void
63  AppendImageFormat(const char *,char *),
64  ChopPathComponents(char *,const size_t),
65  ExpandFilename(char *),
66  GetPathComponent(const char *,PathType,char *),
68 
69 #if defined(__cplusplus) || defined(c_plusplus)
70 }
71 #endif
72 
73 #endif
DirectorySeparator
#define DirectorySeparator
Definition: studio.h:270
MagickExport
#define MagickExport
Definition: method-attribute.h:80
PATH_MAX
#define PATH_MAX
Definition: studio.h:362
policy.h
UndefinedPath
@ UndefinedPath
Definition: utility.h:27
HeadPath
@ HeadPath
Definition: utility.h:30
_DIR
Definition: mac.h:42
GetMagickModule
#define GetMagickModule()
Definition: log.h:29
nt-base-private.h
MagickDelay
MagickExport void MagickDelay(const MagickSizeType)
Definition: utility.c:1727
statistic.h
TailPath
@ TailPath
Definition: utility.h:31
geometry.h
O_BINARY
#define O_BINARY
Definition: studio.h:358
FormatLocaleString
MagickExport ssize_t FormatLocaleString(char *magick_restrict string, const size_t length, const char *magick_restrict format,...)
Definition: locale.c:497
MagickReadDirectory
static int MagickReadDirectory(DIR *directory, struct dirent *entry, struct dirent **result)
Definition: utility-private.h:32
ResizeQuantumMemory
MagickExport void * ResizeQuantumMemory(void *memory, const size_t count, const size_t quantum)
Definition: memory.c:1458
MagickMaxBufferExtent
#define MagickMaxBufferExtent
Definition: blob.h:28
AcquireUniqueFilename
MagickExport MagickBooleanType AcquireUniqueFilename(char *path)
Definition: utility.c:109
IsMagickConflict
MagickExport MagickBooleanType IsMagickConflict(const char *) magick_attribute((__pure__))
GetPathComponents
MagickExport char ** GetPathComponents(const char *, size_t *)
GetMagickPageSize
MagickExport ssize_t GetMagickPageSize(void)
Definition: utility.c:1129
property.h
ResetStringInfo
MagickExport void ResetStringInfo(StringInfo *string_info)
Definition: string.c:1574
GetPathAttributes
MagickExport MagickBooleanType GetPathAttributes(const char *path, void *attributes)
Definition: utility.c:1170
image-private.h
ListFiles
MagickExport char ** ListFiles(const char *directory, const char *pattern, size_t *number_entries)
Definition: utility.c:1606
MultilineCensus
MagickExport size_t MultilineCensus(const char *) magick_attribute((__pure__))
Definition: utility.c:1802
getcwd_utf8
static void getcwd_utf8(char *path, size_t extent)
Definition: utility-private.h:140
ShredFile
MagickPrivate MagickBooleanType ShredFile(const char *path)
Definition: utility.c:1843
AcquireUniqueSymbolicLink
MagickExport MagickBooleanType AcquireUniqueSymbolicLink(const char *, char *)
MagickSizeType
size_t MagickSizeType
Definition: magick-type.h:136
resource_.h
Base64
static const char Base64[]
Definition: utility.c:78
GetPathAttributes
MagickExport MagickBooleanType GetPathAttributes(const char *, void *)
utility.h
IsPathDirectory
static int IsPathDirectory(const char *)
Definition: utility.c:1534
AcquireUniqueFilename
MagickExport MagickBooleanType AcquireUniqueFilename(char *)
S_MODE
#define S_MODE
Definition: studio.h:247
OptionFatalError
@ OptionFatalError
Definition: exception.h:80
random_.h
string_.h
DestroyString
MagickExport char * DestroyString(char *string)
Definition: string.c:821
GetExecutionPath
MagickExport MagickBooleanType GetExecutionPath(char *, const size_t)
ExpandFilename
MagickExport void ExpandFilename(char *)
GetPathComponent
MagickExport void GetPathComponent(const char *path, PathType type, char *component)
Definition: utility.c:1218
MagickTrue
@ MagickTrue
Definition: magick-type.h:201
blob.h
MultilineCensus
MagickExport size_t MultilineCensus(const char *label)
Definition: utility.c:1802
semaphore.h
DestroyRandomInfo
MagickExport RandomInfo * DestroyRandomInfo(RandomInfo *random_info)
Definition: random.c:272
GetPathComponent
MagickExport void GetPathComponent(const char *, PathType, char *)
CLOCKS_PER_SEC
#define CLOCKS_PER_SEC
Definition: timer.c:58
Base64Decode
MagickExport unsigned char * Base64Decode(const char *, size_t *)
Definition: utility.c:343
TraceEvent
@ TraceEvent
Definition: log.h:38
AcquireMagickMemory
MagickExport void * AcquireMagickMemory(const size_t size)
Definition: memory.c:552
ExpandFilenames
MagickExport MagickBooleanType ExpandFilenames(int *, char ***)
_TypeInfo::path
char * path
Definition: type.h:56
ListFiles
MagickExport char ** ListFiles(const char *, const char *, size_t *)
Definition: utility.c:1606
ConcatenateMagickString
MagickExport size_t ConcatenateMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:426
PathType
PathType
Definition: utility.h:26
ConcatenateString
MagickExport MagickBooleanType ConcatenateString(char **magick_restrict destination, const char *magick_restrict source)
Definition: string.c:492
FileToString
MagickExport char * FileToString(const char *filename, const size_t extent, ExceptionInfo *exception)
Definition: string.c:996
MagickPath
@ MagickPath
Definition: utility.h:28
ConfigureEvent
@ ConfigureEvent
Definition: log.h:43
RootPath
@ RootPath
Definition: utility.h:29
Base64Decode
MagickExport unsigned char * Base64Decode(const char *source, size_t *length)
Definition: utility.c:343
dirent
Definition: mac.h:54
LocaleCompare
MagickExport int LocaleCompare(const char *p, const char *q)
Definition: locale.c:1435
remove_utf8
static int remove_utf8(const char *path)
Definition: utility-private.h:215
DestroyExceptionInfo
MagickExport ExceptionInfo * DestroyExceptionInfo(ExceptionInfo *exception)
Definition: exception.c:448
CanonicalPath
@ CanonicalPath
Definition: utility.h:35
BasePathSansCompressExtension
@ BasePathSansCompressExtension
Definition: utility.h:37
IsGlob
MagickExport MagickBooleanType IsGlob(const char *path)
Definition: token.c:600
AcquireUniqueSymbolicLink
MagickExport MagickBooleanType AcquireUniqueSymbolicLink(const char *source, char *destination)
Definition: utility.c:151
MagickPrivate
#define MagickPrivate
Definition: method-attribute.h:81
StringToArgv
MagickExport char ** StringToArgv(const char *text, int *argc)
Definition: string.c:2002
MagickFalse
@ MagickFalse
Definition: magick-type.h:200
GetExecutionPath
MagickExport MagickBooleanType GetExecutionPath(char *path, const size_t extent)
Definition: utility.c:1000
IsEventLogging
MagickExport MagickBooleanType IsEventLogging(void)
Definition: log.c:725
Base64Encode
MagickExport char * Base64Encode(const unsigned char *, const size_t, size_t *)
IsGeometry
MagickExport MagickBooleanType IsGeometry(const char *geometry)
Definition: geometry.c:620
AcquireRandomInfo
MagickExport RandomInfo * AcquireRandomInfo(void)
Definition: random.c:161
S_ISDIR
#define S_ISDIR(mode)
Definition: studio.h:202
registry.h
MagickDelay
MagickExport void MagickDelay(const MagickSizeType milliseconds)
Definition: utility.c:1727
ExpandFilenames
MagickExport MagickBooleanType ExpandFilenames(int *number_arguments, char ***arguments)
Definition: utility.c:744
Base64Encode
MagickExport char * Base64Encode(const unsigned char *blob, const size_t blob_length, size_t *encode_length)
Definition: utility.c:498
IsPathAccessible
MagickExport MagickBooleanType IsPathAccessible(const char *)
Definition: utility.c:1489
IsBasenameSeparator
#define IsBasenameSeparator(c)
Definition: studio.h:274
StringToInteger
static int StringToInteger(const char *magick_restrict value)
Definition: string-private.h:103
log.h
magick_attribute
MagickExport MagickBooleanType magick_attribute((deprecated))
ConstantString
MagickExport char * ConstantString(const char *source)
Definition: string.c:711
MagickCommandOptions
@ MagickCommandOptions
Definition: option.h:38
MagickBooleanType
MagickBooleanType
Definition: magick-type.h:199
ExpandFilename
MagickExport void ExpandFilename(char *path)
Definition: utility.c:613
stat_utf8
static int stat_utf8(const char *path, struct stat *attributes)
Definition: utility-private.h:263
RelinquishMagickMemory
MagickExport void * RelinquishMagickMemory(void *memory)
Definition: memory.c:1162
random_info
static RandomInfo * random_info
Definition: resource.c:112
ExceptionEvent
@ ExceptionEvent
Definition: log.h:46
_ExceptionInfo
Definition: exception.h:103
utility-private.h
IsPathAccessible
MagickExport MagickBooleanType IsPathAccessible(const char *path)
Definition: utility.c:1489
studio.h
SubcanonicalPath
@ SubcanonicalPath
Definition: utility.h:36
RelinquishUniqueFileResource
MagickExport MagickBooleanType RelinquishUniqueFileResource(const char *path)
Definition: resource.c:1287
closedir
MagickExport void closedir(DIR *)
ParseCommandOption
MagickExport ssize_t ParseCommandOption(const CommandOption option, const MagickBooleanType list, const char *options)
Definition: option.c:2605
IsSceneGeometry
MagickExport MagickBooleanType IsSceneGeometry(const char *geometry, const MagickBooleanType pedantic)
Definition: geometry.c:661
BasePath
@ BasePath
Definition: utility.h:32
GetPathComponents
MagickExport char ** GetPathComponents(const char *path, size_t *number_components)
Definition: utility.c:1426
access_utf8
static int access_utf8(const char *path, int mode)
Definition: utility-private.h:92
lib
#define lib
Definition: vms.h:763
AppendImageFormat
MagickExport void AppendImageFormat(const char *format, char *filename)
Definition: utility.c:279
FileCompare
static int FileCompare(const void *x, const void *y)
Definition: utility.c:1591
memory_.h
GetStringInfoDatum
MagickExport unsigned char * GetStringInfoDatum(const StringInfo *string_info)
Definition: string.c:1196
signature-private.h
AcquireUniqueFileResource
MagickExport int AcquireUniqueFileResource(char *path)
Definition: resource.c:600
ChopPathComponents
MagickExport void ChopPathComponents(char *, const size_t)
SubimagePath
@ SubimagePath
Definition: utility.h:34
color.h
AppendImageFormat
MagickExport void AppendImageFormat(const char *, char *)
S_ISREG
#define S_ISREG(mode)
Definition: studio.h:205
GetEnvironmentValue
MagickExport char * GetEnvironmentValue(const char *name)
Definition: string.c:1163
exception-private.h
ThrowFatalException
#define ThrowFatalException(severity, tag)
Definition: exception-private.h:42
GetRandomKey
MagickExport StringInfo * GetRandomKey(RandomInfo *random_info, const size_t length)
Definition: random.c:680
exception.h
GlobExpression
MagickExport MagickBooleanType GlobExpression(const char *magick_restrict expression, const char *magick_restrict pattern, const MagickBooleanType case_insensitive)
Definition: token.c:355
option.h
DestroyStringInfo
MagickExport StringInfo * DestroyStringInfo(StringInfo *string_info)
Definition: string.c:848
CopyMagickString
MagickExport size_t CopyMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:764
GetPolicyValue
MagickExport char * GetPolicyValue(const char *name)
Definition: policy.c:524
list.h
LogMagickEvent
MagickExport MagickBooleanType LogMagickEvent(const LogEventType type, const char *module, const char *function, const size_t line, const char *format,...)
Definition: log.c:1420
AcquireExceptionInfo
MagickExport ExceptionInfo * AcquireExceptionInfo(void)
Definition: exception.c:113
MaxTextExtent
#define MaxTextExtent
Definition: method-attribute.h:89
string-private.h
token.h
ExtensionPath
@ ExtensionPath
Definition: utility.h:33
ResourceLimitFatalError
@ ResourceLimitFatalError
Definition: exception.h:78
AcquireString
MagickExport char * AcquireString(const char *source)
Definition: string.c:126
GetMagickPageSize
MagickExport ssize_t GetMagickPageSize(void)
Definition: utility.c:1129
MagickMin
#define MagickMin(x, y)
Definition: image-private.h:37
open_utf8
static int open_utf8(const char *path, int flags, mode_t mode)
Definition: utility-private.h:162
dirent::d_name
char d_name[255]
Definition: mac.h:56
_StringInfo
Definition: string_.h:30
opendir
MagickExport DIR * opendir(const char *)
ChopPathComponents
MagickExport void ChopPathComponents(char *path, const size_t components)
Definition: utility.c:581
_RandomInfo
Definition: random.c:78
AcquireQuantumMemory
MagickExport void * AcquireQuantumMemory(const size_t count, const size_t quantum)
Definition: memory.c:665
MagickOffsetType
ssize_t MagickOffsetType
Definition: magick-type.h:135
MagickPathExtent
#define MagickPathExtent
Definition: magick-type.h:31