IFFParse Library - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:14:47Z

Text replacement - "<syntaxhighlight>" to "<syntaxhighlight lang="C" line>"

Fredrik Wikstrom: Fixed indentation.

2017-10-18T07:24:13Z

Fixed indentation.

← Older revision		Revision as of 07:24, 18 October 2017
Line 1,058:		Line 1,058:
	* idx = -error - 1;		* idx = -error - 1;
	*/		*/
	char *errormsgs[] = {		char *errormsgs[] = {
	"End of file (not an error).", "End of context (not an error).", "No lexical scope.",		"End of file (not an error).", "End of context (not an error).", "No lexical scope.",
	"Insufficient memory.", "Stream read error.", "Stream write error.",		"Insufficient memory.", "Stream read error.", "Stream write error.",
	"Stream seek error.", "File is corrupt.", "IFF syntax error.",		"Stream seek error.", "File is corrupt.", "IFF syntax error.",
	"Not an IFF file.", "Required call-back hook missing.", "Return to client. You should never see this."		"Not an IFF file.", "Required call-back hook missing.", "Return to client. You should never see this."
	};		};

Line 1,069:		Line 1,069:
	int main(int argc, char **argv)		int main(int argc, char **argv)
	{		{
	struct IFFHandle *iff = NULL;		struct IFFHandle *iff = NULL;
	int32 error;		int32 error;
	int16 cbio;		int16 cbio;

	/* if not enough args or '?', print usage */		/* if not enough args or '?', print usage */
	if(((argc)&&(argc<MINARGS))\|\|(argv[argc-1][0]=='?'))		if(((argc)&&(argc<MINARGS))\|\|(argv[argc-1][0]=='?'))
	{		{
	IDOS->Printf("%s\n", usage);		IDOS->Printf("%s\n", usage);
	goto bye;		goto bye;
	}		}

	/* Check to see if we are doing I/O to the Clipboard. */		/* Check to see if we are doing I/O to the Clipboard. */
Line 1,086:		Line 1,086:
	IIFFParse = (struct IFFParseIFace*)IExec->GetInterface(IFFParseBase, "main", 1, NULL);		IIFFParse = (struct IFFParseIFace*)IExec->GetInterface(IFFParseBase, "main", 1, NULL);
	if (IIFFParse == NULL)		if (IIFFParse == NULL)
	{		{
	IDOS->Printf("Can't open iff parsing library.\n");		IDOS->Printf("Can't open iff parsing library.\n");
	goto bye;		goto bye;
	}		}

	/* Allocate IFF_File structure. */		/* Allocate IFF_File structure. */
	if (!(iff = IIFFParse->AllocIFF()))		if (!(iff = IIFFParse->AllocIFF()))
	{		{
	IDOS->Printf("AllocIFF() failed.\n");		IDOS->Printf("AllocIFF() failed.\n");
	goto bye;		goto bye;
	}		}

	/*		/*
Line 1,103:		Line 1,103:
	*/		*/
	if (cbio)		if (cbio)
	{		{
	/*		/*
	* Set up IFF_File for Clipboard I/O.		* Set up IFF_File for Clipboard I/O.
	*/		*/
	if (!(iff->iff_Stream = (ULONG) IIFFParse->OpenClipboard(PRIMARY_CLIP)))		if (!(iff->iff_Stream = (ULONG) IIFFParse->OpenClipboard(PRIMARY_CLIP)))
	{		{
	IDOS->Printf("Clipboard open failed.\n");		IDOS->Printf("Clipboard open failed.\n");
	goto bye;		goto bye;
⚫	}
⚫	IIFFParse->InitIFFasClip(iff);
	}		}
		⚫	IIFFParse->InitIFFasClip(iff);
			}
	else		else
	{		{
	/* Set up IFF_File for AmigaDOS I/O. */		/* Set up IFF_File for AmigaDOS I/O. */
	if (!(iff->iff_Stream = IDOS->Open(argv[1], MODE_OLDFILE)))		if (!(iff->iff_Stream = IDOS->Open(argv[1], MODE_OLDFILE)))
	{		{
	IDOS->Printf("File open failed.\n");		IDOS->Printf("File open failed.\n");
	goto bye;		goto bye;
	}		}
	IIFFParse->InitIFFasDOS(iff);		IIFFParse->InitIFFasDOS(iff);
	}		}

	/* Start the IFF transaction. */		/* Start the IFF transaction. */
	if (error = IIFFParse->OpenIFF(iff, IFFF_READ))		if (error = IIFFParse->OpenIFF(iff, IFFF_READ))
	{		{
	IDOS->Printf("OpenIFF failed.\n");		IDOS->Printf("OpenIFF failed.\n");
	goto bye;		goto bye;
	}		}

	while (1)		while (1)
	{		{
	/*		/*
	* The interesting bit. IFFPARSE_RAWSTEP permits us to have precision monitoring of the		* The interesting bit. IFFPARSE_RAWSTEP permits us to have precision monitoring of the
Line 1,154:		Line 1,154:
	continue;		continue;
	else if (error)		else if (error)
			{
	/*		/*
	* Leave the loop if there is any other error.		* Leave the loop if there is any other error.
	*/		*/
	break;		break;
		⚫	}


	/* If we get here, error was zero. Print out the current state of affairs. */		/* If we get here, error was zero. Print out the current state of affairs. */
	PrintTopChunk(iff);		PrintTopChunk(iff);
	}		}

	/*		/*
Line 1,175:		Line 1,177:

	bye:		bye:
	if (iff) {		if (iff)
			{
	/* Terminate the IFF transaction with the stream. Free all associated structures. */		/* Terminate the IFF transaction with the stream. Free all associated structures. */
	IIFFParse->CloseIFF(iff);		IIFFParse->CloseIFF(iff);
Line 1,183:		Line 1,186:
	*/		*/
	if (iff->iff_Stream)		if (iff->iff_Stream)
			{
	if (cbio)		if (cbio)
	IIFFParse->CloseClipboard((struct ClipboardHandle *)iff->iff_Stream);		IIFFParse->CloseClipboard((struct ClipboardHandle *)iff->iff_Stream);
	else		else
	IDOS->Close(iff->iff_Stream);		IDOS->Close(iff->iff_Stream);
			}

	/* Free the IFF_File structure itself. */		/* Free the IFF_File structure itself. */
	IIFFParse->FreeIFF(iff);		IIFFParse->FreeIFF(iff);
	}		}
	IExec->DropInterface((struct Interface*)IIFFParse);		IExec->DropInterface((struct Interface*)IIFFParse);
	IExec->CloseLibrary(IFFParseBase);		IExec->CloseLibrary(IFFParseBase);

Fredrik Wikstrom: Fixed indentation.

2017-10-18T07:18:16Z

Fixed indentation.

Show changes

Fredrik Wikstrom: Added missing interface pointer in OpenClipboard() and CloseClipboard() calls.

2017-10-16T13:43:53Z

Added missing interface pointer in OpenClipboard() and CloseClipboard() calls.

← Older revision		Revision as of 13:43, 16 October 2017
Line 876:		Line 876:
	* Set up IFF_File for Clipboard I/O.		* Set up IFF_File for Clipboard I/O.
	*/		*/
	if (!(iff->iff_Stream = (ULONG) OpenClipboard (unitnumber)))		if (!(iff->iff_Stream = (ULONG) IIFFParse->OpenClipboard (unitnumber)))
	{		{
	IDOS->Printf("Clipboard open failed.\n");		IDOS->Printf("Clipboard open failed.\n");
Line 935:		Line 935:
	*/		*/
	IIFFParse->CloseIFF(iff);		IIFFParse->CloseIFF(iff);
	if (iff->iff_Stream) CloseClipboard ((struct ClipboardHandle *)		if (iff->iff_Stream) IIFFParse->CloseClipboard ((struct ClipboardHandle *)
	iff->iff_Stream);		iff->iff_Stream);

	if (!(iff->iff_Stream = (ULONG) OpenClipboard (unitnumber)))		if (!(iff->iff_Stream = (ULONG) IIFFParse->OpenClipboard (unitnumber)))
	{		{
	IDOS->Printf("Reopen of Clipboard failed.\n");		IDOS->Printf("Reopen of Clipboard failed.\n");
Line 1,002:		Line 1,002:
	*/		*/
	if (iff->iff_Stream)		if (iff->iff_Stream)
	CloseClipboard ((struct ClipboardHandle *)		IIFFParse->CloseClipboard ((struct ClipboardHandle *)
	iff->iff_Stream);		iff->iff_Stream);
	/*		/*

Daniel Jedlicka: Fixed a typo, added two missing library interface pointers.

2017-10-15T19:14:44Z

Fixed a typo, added two missing library interface pointers.

← Older revision		Revision as of 19:14, 15 October 2017
Line 1,050:		Line 1,050:
	CONST_STRPTR usage = "Usage: sift IFFfilename (or -c for clipboard)";		CONST_STRPTR usage = "Usage: sift IFFfilename (or -c for clipboard)";

	void PrintTopChunk (struct IFFHandle ); / ~~proto~~ for our function */		void PrintTopChunk(struct IFFHandle ); / prototype for our function */

	/*		/*
Line 1,082:		Line 1,082:
	cbio = (argv[1][0] == '-' && argv[1][1] == 'c');		cbio = (argv[1][0] == '-' && argv[1][1] == 'c');

	struct Library *IFFParseBase = IExec->OpenLibrary ("iffparse.library", 50);		struct Library *IFFParseBase = IExec->OpenLibrary("iffparse.library", 50);
	IIFFParse = (struct ~~IFFPaseIFace~~*)IExec->GetInterface(IFFParseBase, "main", 1, NULL);		IIFFParse = (struct IFFParseIFace*)IExec->GetInterface(IFFParseBase, "main", 1, NULL);
	if (IIFFParse == NULL)		if (IIFFParse == NULL)
	{		{
Line 1,091:		Line 1,091:

	/* Allocate IFF_File structure. */		/* Allocate IFF_File structure. */
	if (!(iff = IIFFParse->AllocIFF ()))		if (!(iff = IIFFParse->AllocIFF()))
	{		{
	IDOS->Printf("AllocIFF() failed.\n");		IDOS->Printf("AllocIFF() failed.\n");
Line 1,098:		Line 1,098:

	/*		/*
	* Internal support is provided for both AmigaDOS files, and the clipboard.device. This bizarre		* Internal support is provided for both AmigaDOS files, and the clipboard.device. This bizarre
	* 'if' statement performs the appropriate machinations for each case.		* 'if' statement performs the appropriate machinations for each case.
	*/		*/
Line 1,106:		Line 1,106:
	* Set up IFF_File for Clipboard I/O.		* Set up IFF_File for Clipboard I/O.
	*/		*/
	if (!(iff->iff_Stream =		if (!(iff->iff_Stream = (ULONG) IIFFParse->OpenClipboard(PRIMARY_CLIP)))
	(ULONG) OpenClipboard (PRIMARY_CLIP)))
	{		{
	IDOS->Printf("Clipboard open failed.\n");		IDOS->Printf("Clipboard open failed.\n");
	goto bye;		goto bye;
	}		}
	IIFFParse->InitIFFasClip (iff);		IIFFParse->InitIFFasClip(iff);
	}		}
	else		else
	{		{
	/* Set up IFF_File for AmigaDOS I/O. */		/* Set up IFF_File for AmigaDOS I/O. */
	if (!(iff->iff_Stream = IDOS->Open (argv[1], MODE_OLDFILE)))		if (!(iff->iff_Stream = IDOS->Open(argv[1], MODE_OLDFILE)))
	{		{
	IDOS->Printf("File open failed.\n");		IDOS->Printf("File open failed.\n");
	goto bye;		goto bye;
	}		}
	IIFFParse->InitIFFasDOS (iff);		IIFFParse->InitIFFasDOS(iff);
	}		}

	/* Start the IFF transaction. */		/* Start the IFF transaction. */
	if (error = IIFFParse->OpenIFF (iff, IFFF_READ))		if (error = IIFFParse->OpenIFF(iff, IFFF_READ))
	{		{
	IDOS->Printf("OpenIFF failed.\n");		IDOS->Printf("OpenIFF failed.\n");
Line 1,135:		Line 1,134:
	{		{
	/*		/*
	* The interesting bit. IFFPARSE_RAWSTEP permits us to have precision monitoring of the		* The interesting bit. IFFPARSE_RAWSTEP permits us to have precision monitoring of the
	* parsing process, which is necessary if we wish to print the structure of an IFF file.		* parsing process, which is necessary if we wish to print the structure of an IFF file.
	* ParseIFF() with _RAWSTEP will return the following things for the following reasons:		* ParseIFF() with _RAWSTEP will return the following things for the following reasons:
Line 1,145:		Line 1,144:
	* <anything else> A parsing error.		* <anything else> A parsing error.
	*/		*/
	error = IIFFParse->ParseIFF (iff, IFFPARSE_RAWSTEP);		error = IIFFParse->ParseIFF(iff, IFFPARSE_RAWSTEP);

	/*		/*
Line 1,161:		Line 1,160:

	/* If we get here, error was zero. Print out the current state of affairs. */		/* If we get here, error was zero. Print out the current state of affairs. */
	PrintTopChunk (iff);		PrintTopChunk(iff);
	}		}

	/*		/*
	* If error was IFFERR_EOF, then the parser encountered the end of		* If error was IFFERR_EOF, then the parser encountered the end of
	* the file without problems. Otherwise, we print a diagnostic.		* the file without problems. Otherwise, we print a diagnostic.
	*/		*/
	if (error == IFFERR_EOF)		if (error == IFFERR_EOF)
Line 1,176:		Line 1,175:
	bye:		bye:
	if (iff) {		if (iff) {
	/* Terminate the IFF transaction with the stream. Free all associated structures. */		/* Terminate the IFF transaction with the stream. Free all associated structures. */
	IIFFParse->CloseIFF (iff);		IIFFParse->CloseIFF(iff);

	/*		/*
Line 1,184:		Line 1,183:
	if (iff->iff_Stream)		if (iff->iff_Stream)
	if (cbio)		if (cbio)
	CloseClipboard ((struct ClipboardHandle *)		IIFFParse->CloseClipboard((struct ClipboardHandle *)iff->iff_Stream);
	iff->iff_Stream);
	else		else
	IDOS->Close (iff->iff_Stream);		IDOS->Close(iff->iff_Stream);

	/* Free the IFF_File structure itself. */		/* Free the IFF_File structure itself. */
	IIFFParse->FreeIFF (iff);		IIFFParse->FreeIFF(iff);
	}		}
	IExec->DropInterface((struct Interface*)IIFFParse);		IExec->DropInterface((struct Interface*)IIFFParse);
	IExec->CloseLibrary (IFFParseBase);		IExec->CloseLibrary(IFFParseBase);

	return RETURN_OK;		return RETURN_OK;
	}		}

	void PrintTopChunk (struct IFFHandle *iff)		void PrintTopChunk(struct IFFHandle *iff)
	{		{
	struct ContextNode *top;		struct ContextNode *top;
Line 1,205:		Line 1,203:

	/* Get a pointer to the context node describing the current context. */		/* Get a pointer to the context node describing the current context. */
	if (!(top = IIFFParse->CurrentChunk (iff)))		if (!(top = IIFFParse->CurrentChunk(iff)))
	return;		return;

Steven Solie: /* FORM FTXT */

2015-11-04T17:49:45Z

FORM FTXT

← Older revision		Revision as of 17:49, 4 November 2015
Line 765:		Line 765:
	The FTXT form is very simple. Generally, for clip and paste operations, you will only be concerned with the CHRS (character string) chunks of an FTXT. There may be one or more CHRS chunks, each of which contains a non-NULL-terminated string of ASCII characters whose length is equal to the length (StoredProperty.sp_Size) of the chunk.		The FTXT form is very simple. Generally, for clip and paste operations, you will only be concerned with the CHRS (character string) chunks of an FTXT. There may be one or more CHRS chunks, each of which contains a non-NULL-terminated string of ASCII characters whose length is equal to the length (StoredProperty.sp_Size) of the chunk.

	Be aware that if you CollectionChunk() the CHRS chunks of an FTXT, the list accumulated by IFFParse will be in reverse order from the chunk order in the file. See the ClipFTXT.c example at the end of this ~~chapter~~ for a simple example of reading (and optionally writing) FTXT to and from the clipboard. See also the [[Clipboard_Device\|Clipboard Device]] and [[Console_Device\|Console Device]] for more information on console clip and paste.		Be aware that if you CollectionChunk() the CHRS chunks of an FTXT, the list accumulated by IFFParse will be in reverse order from the chunk order in the file. See the ClipFTXT.c example at the end of this article for a simple example of reading (and optionally writing) FTXT to and from the clipboard. See also the [[Clipboard_Device\|Clipboard Device]] and [[Console_Device\|Console Device]] for more information on console clip and paste.

	== IFFParse Examples ==		== IFFParse Examples ==

Steven Solie: /* Composite Data Types */

2015-11-04T17:49:16Z

Composite Data Types

← Older revision		Revision as of 17:49, 4 November 2015
Line 66:		Line 66:
	One of the most popular IFF FORMs that has been defined is the ILBM standard. This is how most Amiga bitmap imagery is stored. Since this is the most common IFF file, it is used frequently as an example.		One of the most popular IFF FORMs that has been defined is the ILBM standard. This is how most Amiga bitmap imagery is stored. Since this is the most common IFF file, it is used frequently as an example.

	Here is the output of a program called “Sift.c” that displays a text description of the contents of an IFF file (~~“Sift~~.c” is listed at the end of this ~~chapter~~). The file shown below is a fairly simple ILBM.		Here is the output of a program called “Sift.c” that displays a text description of the contents of an IFF file ([[#IFF Scanner Example\|Sift.c]] is listed at the end of this article). The file shown below is a fairly simple ILBM.

	. FORM 11068 ILBM		. FORM 11068 ILBM

Steven Solie: /* Function Reference */

2015-11-04T17:48:01Z

Function Reference

← Older revision		Revision as of 17:48, 4 November 2015
Line 1,225:		Line 1,225:
	== Function Reference ==		== Function Reference ==

	The following are brief descriptions of the IFFParse functions discussed in this ~~chapter~~. Further information about these and other IFFParse functions can be found in the SDK.		The following are brief descriptions of the IFFParse functions discussed in this article. Further information about these and other IFFParse functions can be found in the SDK.

	{\| class="wikitable"		{\| class="wikitable"

Steven Solie: /* Interpreting the Scan Line Data */

2015-11-04T17:47:45Z

Interpreting the Scan Line Data

← Older revision		Revision as of 17:47, 4 November 2015
Line 749:		Line 749:
	But, if the picture is HAM or HALFBRITE, it is interpreted differently. Hopefully, if the picture is HAM or HALFBRITE, the package that saved it properly saved a CAMG chunk (look at a hex dump of your file with ASCII interpretation - you will see the chunks - they all start with a 4-ASCII-char chunk ID). If the picture is 6 planes deep and has no CAMG chunk, it is probably HAM. If you see a CAMG chunk, the ‘CAMG’ is followed by the 32-bit chunk length, and then the 32-bit Amiga view mode flags.		But, if the picture is HAM or HALFBRITE, it is interpreted differently. Hopefully, if the picture is HAM or HALFBRITE, the package that saved it properly saved a CAMG chunk (look at a hex dump of your file with ASCII interpretation - you will see the chunks - they all start with a 4-ASCII-char chunk ID). If the picture is 6 planes deep and has no CAMG chunk, it is probably HAM. If you see a CAMG chunk, the ‘CAMG’ is followed by the 32-bit chunk length, and then the 32-bit Amiga view mode flags.

	HAM pictures will have the 0x800 bit set in CAMG chunk ViewModes. HALFBRITE pictures will have the 0x80 bit set. See the graphics library ~~chapters or the ''Amiga Hardware Reference Manual''~~ for more information on HAM and HALFBRITE modes.		HAM pictures will have the 0x800 bit set in CAMG chunk ViewModes. HALFBRITE pictures will have the 0x80 bit set. See the graphics library articles for more information on HAM and HALFBRITE modes.

	==== Other ILBM Notes ====		==== Other ILBM Notes ====

Steven Solie: /* Initialization */

2015-11-04T17:46:55Z

Initialization

← Older revision		Revision as of 17:46, 4 November 2015
Line 111:		Line 111:
	=== Initialization ===		=== Initialization ===

	As shown above, the IFFHandle structure contains the public field iff_Stream. This is a longword that must be initialized to contain something meaningful to the stream manager. IFFParse never looks at this field itself (at least not directly). Your iff_Stream may be an AmigaDOS filehandle, or an IFFParse ClipboardHandle, or a custom stream of any type if you provide your own custom stream handler (see the section on ~~“Custom~~ Stream ~~Handlers”~~ ~~later in this~~ ~~chapter~~). You must initialize your IFFHandle structure’s iff_Stream to your stream, and then initialize the IFFHandle’s flags and stream hook.		As shown above, the IFFHandle structure contains the public field iff_Stream. This is a longword that must be initialized to contain something meaningful to the stream manager. IFFParse never looks at this field itself (at least not directly). Your iff_Stream may be an AmigaDOS filehandle, or an IFFParse ClipboardHandle, or a custom stream of any type if you provide your own custom stream handler (see the section on [[#Custom Stream Handlers\|Custom Stream Handlers]]). You must initialize your IFFHandle structure’s iff_Stream to your stream, and then initialize the IFFHandle’s flags and stream hook.

	Three sample initializations are shown here. In the case of the internal DOS stream manager, iff_Stream is an AmigaDOS filehandle as returned by Open():		Three sample initializations are shown here. In the case of the internal DOS stream manager, iff_Stream is an AmigaDOS filehandle as returned by Open():