2 utility - ImageMagick Utility Routines�� �  0 




NAME

&utility - ImageMagick Utility Routines








SYNOPSIS

3AppendImageFormat(format,filename)

Basename(name)

)ExpandFilename(filename)

+ExpandFilenames(argc,argv)

3GlobExpression(expression,pattern)

.status=IsAccessible(filename)

-status=IsDirectory(filename)

-value=LSBFirstReadLong(file)

.value=LSBFirstReadShort(file)

.LSBFirstWriteLong(value,file)

/LSBFirstWriteShort(value,file)

;filelist=ListColors(pattern,number_colors)

Efilelist=ListFiles(directory,pattern,number_entries)

)LocaleFilename(filename)

-MSBFirstOrderLong(p,length);

-value=MSBFirstReadLong(file)

.value=MSBFirstReadShort(file)

.MSBFirstWriteLong(value,file)

/MSBFirstWriteShort(value,file)

2geometry=PostscriptGeometry(page)

=status=ReadData(data,size,number_items,file)

0client_name=SetClientName(name)

-argv=StringToArgv(text,argc)

(list=StringToList(text)

Strip(data)

,TemporaryFilename(filename)






9

FUNCTION DESCRIPTIONS






1

AppendImageFormat

IFunction AppendImageFormat appends the image format type to the filename.@If an extension to the file already exists, it is first removed.

/The format of the AppendImageFormat routine is:

0

         AppendImageFormat(format,filename)


(A description of each parameter follows.



$
format:
HSpecifies a pointer to an array of characters. This is the format of theimage.



filename:
FSpecifies a pointer to an array of characters. The unique file name isreturned in this array.








Basename

EFunction Basename removes the path name component and any extensions.

'The format of the Basename function is:



        Basename(name)


(A description of each parameter follows:




name:
ASpecifies a pointer to an character array that contains the name.






+

ExpandFilename

2Function ExpandFilename expands '~' in a filename.

-The format of the ExpandFilename function is:

%

        ExpandFilename(filename)


(A description of each parameter follows:




filename:
ESpecifies a pointer to an character array that contains the filename.






-

ExpandFilenames

HFunction ExpandFilenames checks each argument of the command line vectorJand expands it if they have a wildcard character. For example, *.jpg might&expand to: bird.jpg rose.jpg tiki.jpg.

.The format of the ExpandFilenames function is:

'

        ExpandFilenames(argc,argv)


(A description of each parameter follows:




argc:
JSpecifies a pointer to an integer describing the number of elements in theargument vector.



argv:
JSpecifies a pointer to a text array containing the command line arguments.






+

GlobExpression

KFunction GlobExpression returns True if the expression matches the pattern.

-The format of the GlobExpression function is:

/

        GlobExpression(expression,pattern)


(A description of each parameter follows:




expression:
<Specifies a pointer to a text string containing a file name.



pattern:
:Specifies a pointer to a text string containing a pattern.






'

IsAccessible

HFunction IsAccessible returns True if the file as defined by filename is accessible.

*The format of the IsAccessible routine is:

+

         status=IsAccessible(filename)


(A description of each parameter follows.




status:
HFunction IsAccessible returns True is the file as defined by filename is(accessible, otherwise False is returned.



filename:
FSpecifies a pointer to an array of characters. The unique file name isreturned in this array.






%

IsDirectory

IFunction IsDirectory returns True if the file as defined by filename is aHdirectory. Once MetroWerks write a stat(2) function, we can*remove the chdir(2) function.

*The format of the IsAccessible routine is:

*

         status=IsDirectory(filename)


(A description of each parameter follows.




status:
IFunction IsDirectory returns True is the file as defined by filename is a'directory, otherwise False is returned.



filename:
FSpecifies a pointer to an array of characters. The unique file name isreturned in this array.






#

ListColors

KFunction ListColors reads the X client color database and returns a list ofFcolors contained in the database sorted in ascending alphabetic order.

)The format of the ListColors function is:

7

        filelist=ListColors(pattern,number_colors)


(A description of each parameter follows:




filelist:
JFunction ListColors returns a list of colors contained in the database. If5the database cannot be read, a NULL list is returned.



pattern:
:Specifies a pointer to a text string containing a pattern.



number_colors:
6This integer returns the number of colors in the list.






!

ListFiles

FFunction ListFiles reads the directory specified and returns a list ofJfilenames contained in the directory sorted in ascending alphabetic order.

(The format of the ListFiles function is:

A

        filelist=ListFiles(directory,pattern,number_entries)


(A description of each parameter follows:




filelist:
JFunction ListFiles returns a list of filenames contained in the directory.HIf the directory specified cannot be read or it is a file a NULL list is returned.



directory:
ASpecifies a pointer to a text string containing a directory name.



pattern:
:Specifies a pointer to a text string containing a pattern.



number_entries:
9This integer returns the number of filenames in the list.






+

LocaleFilename

IFunction LocaleFilename replaces the contents of the string pointed to by9filename by a unique file name relative to the directory.

,The format of the LocaleFilename routine is:

&

         LocaleFilename(filename)


(A description of each parameter follows.




filename:
FSpecifies a pointer to an array of characters. The unique file name isreturned in this array.






/

LSBFirstReadLong

DFunction LSBFirstReadLong reads a long value as a 32 bit quantity in#least-significant byte first order.

.The format of the LSBFirstReadLong routine is:

*

         value=LSBFirstReadLong(file)


(A description of each parameter follows.




value:
FFunction LSBFirstReadLong returns an unsigned long read from the file.



file:
)Specifies the file to read the data from.






1

LSBFirstReadShort

FFunction LSBFirstReadShort reads a short value as a 16 bit quantity in#least-significant byte first order.

/The format of the LSBFirstReadShort routine is:

+

         value=LSBFirstReadShort(file)


(A description of each parameter follows.




value:
HFunction LSBFirstReadShort returns an unsigned short read from the file.



file:
)Specifies the file to read the data from.






1

LSBFirstWriteLong

FFunction LSBFirstWriteLong writes a long value as a 32 bit quantity in#least-significant byte first order.

/The format of the LSBFirstWriteLong routine is:

+

         LSBFirstWriteLong(value,file)


(A description of each parameter follows.




value:
Specifies the value to write.



file:
(Specifies the file to write the data to.






3

LSBFirstWriteShort

GFunction LSBFirstWriteShort writes a long value as a 16 bit quantity in#least-significant byte first order.

0The format of the LSBFirstWriteShort routine is:

,

         LSBFirstWriteShort(value,file)


(A description of each parameter follows.




value:
Specifies the value to write.



file:
(Specifies the file to write the data to.






1

MSBFirstOrderLong

IFunction MSBFirstOrderLong converts a least-significant byte first buffer+of integers to most-significant byte first.

/The format of the MSBFirstOrderLong routine is:

*

         MSBFirstOrderLong(p,length);


(A description of each parameter follows.




p:
,Specifies a pointer to a buffer of integers.



length:
#Specifies the length of the buffer.






3

MSBFirstOrderShort

JFunction MSBFirstOrderShort converts a least-significant byte first buffer+of integers to most-significant byte first.

0The format of the MSBFirstOrderShort routine is:

+

     MSBFirstOrderLongShort(p,length);


(A description of each parameter follows.




p:
,Specifies a pointer to a buffer of integers.



length:
#Specifies the length of the buffer.






1

MSBFirstReadShort

FFunction MSBFirstReadShort reads a short value as a 16 bit quantity in"most-significant byte first order.

/The format of the MSBFirstReadShort routine is:

+

         value=MSBFirstReadShort(file)


(A description of each parameter follows.




value:
HFunction MSBFirstReadShort returns an unsigned short read from the file.



file:
)Specifies the file to read the data from.






/

MSBFirstReadLong

DFunction MSBFirstReadLong reads a long value as a 32 bit quantity in"most-significant byte first order.

.The format of the MSBFirstReadLong routine is:

*

         value=MSBFirstReadLong(file)


(A description of each parameter follows.




value:
FFunction MSBFirstReadLong returns an unsigned long read from the file.



file:
)Specifies the file to read the data from.






1

MSBFirstWriteLong

FFunction MSBFirstWriteLong writes a long value as a 32 bit quantity in"most-significant byte first order.

/The format of the MSBFirstWriteLong routine is:

+

         MSBFirstWriteLong(value,file)


(A description of each parameter follows.




value:
Specifies the value to write.



file:
(Specifies the file to write the data to.






3

MSBFirstWriteShort

GFunction MSBFirstWriteShort writes a long value as a 16 bit quantity in"most-significant byte first order.

0The format of the MSBFirstWriteShort routine is:

,

         MSBFirstWriteShort(value,file)


(A description of each parameter follows.




value:
Specifies the value to write.



file:
(Specifies the file to write the data to.






-

MultilineCensus

KFunction MultilineCensus returns the number of lines within a label. A line!is represented by a \n character.

,The format of the MultilineCenus routine is:



     MultilineCenus(label)


(A description of each parameter follows.




label:
#This character string is the label.






3

PostscriptGeometry

KFunction PostscriptGeometry replaces any page mneumonic with the equivalentsize in picas.

0The format of the PostscriptGeometry routine is:

/

         geometry=PostscriptGeometry(page)


(A description of each parameter follows.




page:
ESpecifies a pointer to an array of characters. The string is either aBPostscript page name (e.g. A4) or a postscript page geometry (e.g.612x792+36+36).








ReadData

FFunction ReadData reads data from the image file and returns it. If itJcannot read the requested number of items, False is returned indicating anerror.

&The format of the ReadData routine is:

9

        status=ReadData(data,size,number_items,file)


(A description of each parameter follows:




status:
DFunction ReadData returns True if all the data requested is obtainedwithout error, otherwise False.



data:
BSpecifies an area to place the information reuested from the file.



size:
HSpecifies an integer representing the length of an individual item to beread from the file.



number_items:
FSpecifies an integer representing the number of items to read from thefile.



file:
"Specifies a file to read the data.






)

ReadDataBlock

IFunction ReadDataBlock reads data from the image file and returns it. The>amount of data is determined by first reading a count byte. IfIReadDataBlock cannot read the requested number of items, `-1' is returnedindicating an error.

&The format of the ReadData routine is:

#

    status=ReadData(data,file)


(A description of each parameter follows:




status:
JFunction ReadData returns the number of characters read unless there is anerror, otherwise `-1'.



data:
BSpecifies an area to place the information reuested from the file.



file:
"Specifies a file to read the data.






)

SetClientName

EFunction SetClientName sets the client name if the name is specified..Otherwise the current client name is returned.

+The format of the SetClientName routine is:

,

        client_name=SetClientName(name)


(A description of each parameter follows:




client_name:
7Function SetClientName returns the current client name.



status:
Specifies the new client name.






'

StringToArgv

IFunction StringToArgv converts a text string into command line arguments.

*The format of the StringToArgv routine is:

)

        argv=StringToArgv(text,argc)


(A description of each parameter follows:




argv:
EFunction StringToArgv returns the string list unless an error occurs,otherwise NULL.



text:
,Specifies the string to segment into a list.



argc:
AThis integer pointer returns the number of arguments in the list.






'

StringToList

JFunction StringToList converts a text string into a list by segmenting theHtext string at each carriage return discovered. The list is converted toGHEX characters if any control characters are discovered within the textstring.

*The format of the StringToList routine is:

$

        list=StringToList(text)


(A description of each parameter follows:




list:
EFunction StringToList returns the string list unless an error occurs,otherwise NULL.



text:
,Specifies the string to segment into a list.








Strip

KFunction Strip strips the whitespace from the beginning and end of a stringof characters.

#The format of the Strip routine is:



       Strip(data)


(A description of each parameter follows:




data:
!Specifies an array of characters.






1

TemporaryFilename

IFunction TemporaryFilename replaces the contents of the string pointed to"by filename by a unique file name.

/The format of the TemporaryFilename routine is:

)

         TemporaryFilename(filename)


(A description of each parameter follows.




filename:
FSpecifies a pointer to an array of characters. The unique file name isreturned in this array.