AIEPSFilter Class Reference

A filter that imports EPS files in Adobe Illustrator EPS format. More...

#include <ai_eps.h>

Inheritance diagram for AIEPSFilter:

List of all members.

Public Member Functions
	AIEPSFilter ()
	Constructor for an AIEPSFilter object. The object should be initialised before use.
virtual BOOL	Init ()
	Initialise an AIEPSFilter object.
BOOL	PrepareToExport (CCLexFile *, Spread *pSpread)
	Prepare to import EPS data using this filter. This sets up the filter to a sensible state for reading.
TCHAR *	GetEPSCommand (EPSCommand Cmd)
	Given an EPS token, return the string representation of it; mainly for debugging purposes.
virtual BOOL	NeedsPrintComponents (void)
	Informs the print components code that no data should be written.
Protected Member Functions
virtual BOOL	WriteNodes (RenderRegion *pRegion, ExportDC *pDC, BOOL VisibleLayersOnly, BOOL CheckSelected, BOOL ShowProgress)
	Exports the nodes from the tree. Unlike the standard export, the layer is dispatched first, followed by its children in their usual order.
virtual void	LookUpToken ()
	Compare the current token against the AI keywords to see if it is one of them.
virtual BOOL	ProcessToken ()
	Processes EPS tokens that are not part of the standard Illustrator set, or which need to be handled differently to the standard Illustrator meanings. i.e. this is the function that handles all the AI EPS operators.
INT32	EPSHeaderIsOk (ADDR pFileHeader, UINT32 HeaderSize)
	Checks to see if the EPS comment headers specify that this is an AI generated EPS file, as required.
virtual void	ProcessTextMatrix (Matrix *pMatrix)
	Having read a text object position matrix from the file, we may (dependent on the filter type), need to process it in some way, ie add in the spread origin.
virtual BOOL	SetTextLineSpacing (INT32 Type, INT32 EMLSpace, MILLIPOINT MLSpace, double DLSpace)
	This is simply here to allow Illustrator import to catch attempts to set the line spacing to zero.
Protected Attributes
BOOL	bDoClip
Static Protected Attributes
static CommandMap	AICommands []
Private Member Functions
	CC_DECLARE_DYNAMIC (AIEPSFilter)

---

Detailed Description

A filter that imports EPS files in Adobe Illustrator EPS format.

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>

Date:

08/03/94

See also:

EPSFilter

Definition at line 130 of file ai_eps.h.

---

Constructor & Destructor Documentation

AIEPSFilter::AIEPSFilter (   )

Constructor for an AIEPSFilter object. The object should be initialised before use. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/10/93 See also: EPSFilter::Init Definition at line 161 of file ai_eps.cpp. { // Set up filter descriptions. FilterNameID = _R(IDT_AIEPS_FILTERNAME); FilterInfoID = _R(IDT_AIEPS_FILTERINFO); ImportMsgID = _R(IDT_IMPORTMSG_AI); FilterID = FILTERID_AIEPS; #ifndef STANDALONE Flags.CanImport = TRUE; //WEBSTER-Martin-27/01/97 #ifdef WEBSTER Flags.CanExport = FALSE; #else Flags.CanExport = TRUE; #endif //WEBSTER #else Flags.CanImport = TRUE; Flags.CanExport = FALSE; #endif AdjustOrigin = FALSE; // Illustrator gets it right... bDoClip = FALSE; }

---

Member Function Documentation

AIEPSFilter::CC_DECLARE_DYNAMIC (  AIEPSFilter   )  [private]

INT32 AIEPSFilter::EPSHeaderIsOk (  ADDR  pFileHeader, UINT32  HeaderSize )  [protected, virtual]

Checks to see if the EPS comment headers specify that this is an AI generated EPS file, as required. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/02/94 Returns: TRUE if the header is ok and import should proceed, FALSE if not. Reimplemented from EPSFilter. Reimplemented in AI5EPSFilter, and AI8EPSFilter. Definition at line 230 of file ai_eps.cpp. { UINT32 Lines = 0; TCHAR *Buffer = NULL; // !PS-Adobe line is ok - check creator line... CCMemTextFile HeaderFile ( reinterpret_cast<char *> ( pFileHeader ), HeaderSize ); if( HeaderFile.IsMemFileInited () == FALSE || HeaderFile.InitLexer () == FALSE ) { HeaderFile.close(); return 0; } // Graeme (28/6/00) - Adobe have changed their file format, and so the first line can // now be a %PDF directive. Therefore look for this directive in the first twenty // lines. while ( ( Lines < 100 ) && !HeaderFile.eof () ) { // Get the current line from the file. HeaderFile.GetLineToken(); Buffer = const_cast<TCHAR *> ( HeaderFile.GetTokenBuf () ); // Ensure that it's OK. ERROR2IF(Buffer == 0, 0, "Returned buffer from lex file == 0"); // Increment the line counter. Lines++; if (camStrncmp(Buffer, _T("%!PS-Adobe"), 10) == 0) { // Now find the %%Creator string. while ((Lines < 100) && !HeaderFile.eof()) { HeaderFile.GetLineToken(); Buffer = const_cast<TCHAR *> ( HeaderFile.GetTokenBuf() ); ERROR2IF(Buffer == 0, 0, "Returned buffer from lex file == 0"); Lines++; // Return TRUE if this file was created by Illustrator, or has been exported // in Illustrator format. if (camStrncmp(Buffer, _T("%%Creator: Adobe Illustrator"), 28) == 0) { // We definitely want this. HeaderFile.close(); return 9; } // Another variation on the Illustrator theme if (camStrncmp(Buffer, _T("%%Creator: AI"), 13) == 0) { // We definitely want this. HeaderFile.close(); return 9; } // yet another variation (see cru_logo.eps for this one) if (camStrncmp(Buffer, _T("%%Creator: ps2ai.ps"), 19) == 0) { HeaderFile.close (); return 9; } // If there is a creator field, see if it mentions Illustrator // NOTE: this test must be the last one of the "Creator:" tests. if (camStrncmp(Buffer, _T("%%Creator:"), 10) == 0) { // Found the creator line - does it contain the word Illustrator? if (camStrstr( (const TCHAR*)Buffer, _T("Illustrator")) != NULL) { HeaderFile.close(); return 9; } else break; } // If we find the compression token then stop the search as we don't want to // start looking in the compressed data! if (camStrncmp(Buffer, _T("%%Compression:"), 14)==0) break; } // Remember to close the file before returning. HeaderFile.close(); // Didn't find a suitable Creator line, but the EPS line was ok, so return // that we're interested, but not sure. return 5; } // If we find the compression token then stop the search as we don't want to start // looking in the compressed data! if (camStrncmp(Buffer, _T("%%Compression:"), 14)==0) break; } // Remember to close the file before returning. HeaderFile.close(); // This file type isn't suitable. return 0; }

TCHAR * AIEPSFilter::GetEPSCommand (  EPSCommand  Cmd  )

Given an EPS token, return the string representation of it; mainly for debugging purposes. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/02/94 Parameters: Cmd  - the EPS token, e.g. EPSC_aoa [INPUTS] Returns: Pointer to the string representation of the token, e.g. "aoa" Reimplemented from EPSFilter. Reimplemented in AI5EPSFilter. Definition at line 735 of file ai_eps.cpp. { INT32 i = 0; while (AICommands[i].Cmd != EPSC_Invalid) { if (AICommands[i].Cmd == Cmd) return AICommands[i].CmdStr; // Try next command i++; } // Couldn't find it - default to base class method return EPSFilter::GetEPSCommand(Cmd); }

BOOL AIEPSFilter::Init (  void   )  [virtual]

Initialise an AIEPSFilter object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 28/02/94 Returns: TRUE if the filter was initialised ok, FALSE otherwise. Errors: Will fail if not enough memory to initialise the EPS stack. See also: EPSStack Reimplemented from EPSFilter. Reimplemented in AI5EPSFilter, and AI8EPSFilter. Definition at line 201 of file ai_eps.cpp. { // Get the OILFilter object pOILFilter = new AIEPSOILFilter(this); if (pOILFilter == NULL) return FALSE; // Load the description strings FilterName.Load(FilterNameID); FilterInfo.Load(FilterInfoID); bDoClip = FALSE; // All ok return TRUE; }

void AIEPSFilter::LookUpToken (   )  [protected, virtual]

Compare the current token against the AI keywords to see if it is one of them. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 25/02/94 Returns: TRUE if the token is an AI EPS token; FALSE if not. See also: EPSFilter::LookUpToken; EPSFilter::DecodeToken Reimplemented from EPSFilter. Reimplemented in AI5EPSFilter, and AI8EPSFilter. Definition at line 394 of file ai_eps.cpp. { // Not interested in comments if (Token == EPSC_Comment) return; // Check to see if it is a keyword - cycle through the array of keyword names and // compare against our token (could use a hash table?) INT32 i = 0; while (AICommands[i].Cmd != EPSC_Invalid) { if (camStrcmp(TokenBuf, AICommands[i].CmdStr) == 0) { // Found the token - set the token variable and return success Token = AICommands[i].Cmd; return; } // Try next command i++; } // Did not find this token - pass on to base class. EPSFilter::LookUpToken(); }

BOOL AIEPSFilter::NeedsPrintComponents (  void   )  [virtual]

Informs the print components code that no data should be written. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/00 Returns: FALSE - AI files don't need print components. Reimplemented from EPSFilter. Definition at line 762 of file ai_eps.cpp. { // We don't want print components! return FALSE; }

BOOL AIEPSFilter::PrepareToExport (  CCLexFile *  pFile, Spread *  pSpread )  [virtual]

Prepare to import EPS data using this filter. This sets up the filter to a sensible state for reading. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 15/04/94 Parameters: pFile  - The file that we are to Export to [INPUTS] pSpread - The spread to export Returns: TRUE if succeeded, FALSE if not (e.g. no memory for EPS stack) Errors: Out of memory. See also: EPSFilter::DoImport; EPSFilter::CleanUpAfterImport Scope: Private Reimplemented from EPSFilter. Definition at line 351 of file ai_eps.cpp. { // Use base class to do most of it if (!EPSFilter::PrepareToExport(pFile, pSpread)) return FALSE; // Create a new render region to export to: // Don't care about clip regions when exporting - create a null region. DocRect NullClipRect; NullClipRect.MakeEmpty(); // Don't use rendering matrix when exporting EPS as it uses fractional coordinates. Matrix Identity; // Don't use view scale; set to 1 FIXED16 Scale(1); // Create the region specific to our filter. ExportRegion = new AIEPSRenderRegion(NullClipRect, Identity, Scale); if (ExportRegion == NULL) return FALSE; // Attach to the right device. ExportRegion->AttachDevice(DocView::GetSelected(), ExportDCPtr->GetDC(), pSpread); // All ok return TRUE; };

void AIEPSFilter::ProcessTextMatrix (  Matrix *  pMatrix  )  [protected, virtual]

Having read a text object position matrix from the file, we may (dependent on the filter type), need to process it in some way, ie add in the spread origin. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 18/8/95 Returns: - Reimplemented from EPSFilter. Definition at line 861 of file ai_eps.cpp. { // We need to find the current import spread // and add in the spread origin to this matrix. DocCoord pos,result; pMatrix->GetTranslation(pos); if (ImportInfo.pSpread->PagesCoordToSpreadCoord(&result,pos)) pMatrix->SetTranslation(result); }

BOOL AIEPSFilter::ProcessToken (   )  [protected, virtual]

Processes EPS tokens that are not part of the standard Illustrator set, or which need to be handled differently to the standard Illustrator meanings. i.e. this is the function that handles all the AI EPS operators. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 25/02/94 Returns: TRUE if token understood and processed ok, FALSE if not. Errors: Syntax error in EPS, Out of memory. See also: EPSFilter::ProcessToken Reimplemented from EPSFilter. Reimplemented in AI5EPSFilter, and AI8EPSFilter. Definition at line 434 of file ai_eps.cpp. { // Decode the command, and execute it... switch (Token) { // // Various random text stuff - ignore it for now. // case EPSC_z: if (!Stack.Discard(5)) goto EPSError; break; case EPSC_e: if (!Stack.DiscardArray()) goto EPSError; break; case EPSC_t: if (!Stack.Discard()) goto EPSError; break; case EPSC_T: break; // These are the new implementations of the appropriate illustrator tokens. // In order to work properly and handle complex paths properly, the // stroking and filling commands have to do something different if they're // in the middle of some kind of complex path or other /* /N % - N - { _pola 0 eq { _doClip 1 eq {clip /_doClip 0 ddef} if newpath } { /CRender {N} ddef }ifelse } def */ case EPSC_N: case EPSC_n: if (EPSFlags.ComplexPath == 0) { if (bDoClip) { // cannot continue as there's no path if (pInkPath == NULL) goto EPSError; if (!ClipRegion.AddNewClippingPath(pInkPath)) // Error! return FALSE; bDoClip = FALSE; pInkPath->ClearPath(); delete pPath; pPath = NULL; pInkPath = NULL; } else { // Graeme (14/4/00) - Catch NULL pointers. if ( pInkPath != NULL ) { // Deleting pInkPath throws access violations, which basically break // the import proceedure. Do not add a delete pInkPath line here! pInkPath->ClearPath (); pInkPath = NULL; } // Delete isn't worried about NULL pointers. delete pPath; pPath = NULL; } } else { // We have a deferred render situation. Simply remember the token DeferredToken = Token; } break; /* /W % - W - { /_doClip 1 ddef } def */ case EPSC_W: bDoClip = TRUE; break; /*u % - *u - { _pola 1 add /_pola exch ddef } def */ case EPSC__u: EPSFlags.ComplexPath++; break; /*U % - *U - { _pola 1 sub /_pola exch ddef _pola 0 eq {CRender} if } def */ case EPSC__U: EPSFlags.ComplexPath--; if (EPSFlags.ComplexPath <0) return FALSE; if (EPSFlags.ComplexPath == 0) { EPSCommand oldToken = Token; Token = DeferredToken; if (!ProcessToken()) return FALSE; Token = oldToken; } break; // Now come the actualy path rendering primitives // These basically amount to either stroking or // filling the path, or both. However, if the // ComplexPath flag is not zero, they will do nothing // and merely record their token as the deferred token // Allowing the *U operator to render them at the end // of the complex group. // Clipping is equally complicated - if bDoClip is set // when ComplexPath is zero, it adds the current path // to the clipping region (i.e. clips to the clipping // region). // if bDoClip is zero (FALSE) then it goes ahead and // renders the path as it normally would /* /N % - N - { _pola 0 eq { _doClip 1 eq {clip /_doClip 0 ddef} if newpath } { /CRender {N} ddef }ifelse } def /n % - n - {N} def /F % - F - { _pola 0 eq { _doClip 1 eq { gsave _pf grestore clip newpath /_lp /none ddef _fc /_doClip 0 ddef } { _pf }ifelse } { /CRender {F} ddef }ifelse } def /f % - f - { closepath F } def /S % - S - { _pola 0 eq { _doClip 1 eq { gsave _ps grestore clip newpath /_lp /none ddef _sc /_doClip 0 ddef } { _ps }ifelse } { /CRender {S} ddef }ifelse } def /s % - s - { closepath S } def /B % - B - { _pola 0 eq { _doClip 1 eq % F clears _doClip gsave F grestore { gsave S grestore clip newpath /_lp /none ddef _sc /_doClip 0 ddef } { S }ifelse } { /CRender {B} ddef }ifelse } def /b % - b - { closepath B } def */ case EPSC_S: case EPSC_b: case EPSC_B: case EPSC_f: case EPSC_F: case EPSC_s: if (EPSFlags.ComplexPath > 0) { DeferredToken = Token; break; } if (bDoClip) { // cannot continue as there's no path if (pInkPath == NULL) goto EPSError; if (!ClipRegion.AddNewClippingPath(pInkPath)) // Error! return FALSE; bDoClip = FALSE; pInkPath->ClearPath(); delete pPath; pPath = NULL; pInkPath = NULL; break; } // Since now all we want is for it to do what the default // filter will do, pass it on. return EPSFilter::ProcessToken(); break; case EPSC_H: case EPSC_h: // This operator does nothing in Illustrator. Let's follow suit: break; default: // Token not understood - pass on to base class return EPSFilter::ProcessToken(); } // No errors encountered while parsing this token and its operands. return TRUE; // Error handlers: EPSError: HandleEPSError(); return FALSE; #if 0 NoMemory: HandleNoMemory(); return FALSE; #endif }

BOOL AIEPSFilter::SetTextLineSpacing (  INT32  Type, INT32  EMLSpace, MILLIPOINT  MLSpace, double  DLSpace )  [protected, virtual]

This is simply here to allow Illustrator import to catch attempts to set the line spacing to zero. Author: Chris_Gallimore (Xara Group Ltd) <camelotdev@xara.com> Date: 2/4/2001 Parameters: see  Filter::SetLineSpacing () [INPUTS] Returns: BOOL - whether the call to EPSFilter::SetLineSpacing succeeded. Reimplemented from Filter. Definition at line 883 of file ai_eps.cpp. { BOOL isZero = FALSE; BOOL success = FALSE; // is the line spacing going to be set to zero switch (Type) { case 0: // Em based if (EMLSpace) isZero = FALSE; else isZero = TRUE; break; case 1: // Millipoint based if (MLSpace) isZero = FALSE; else isZero = TRUE; break; case 2: // Proportional if (DLSpace) isZero = FALSE; else isZero = TRUE; } // for some reason, Illustrator assumes that a line spacing of 0 actually // means 100% and confuses more capable apps by overriding this with // final-form (i.e. printing only) attributes. if (isZero) { success = EPSFilter::SetTextLineSpacing(2,0,0,1.0); } else { success = EPSFilter::SetTextLineSpacing(Type, EMLSpace, MLSpace, DLSpace); } return success; }

BOOL AIEPSFilter::WriteNodes (  RenderRegion *  pRegion, ExportDC *  pDC, BOOL  VisibleLayersOnly, BOOL  CheckSelected, BOOL  ShowProgress )  [protected, virtual]

Exports the nodes from the tree. Unlike the standard export, the layer is dispatched first, followed by its children in their usual order. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> (from Neville's original code) Date: 12/4/00 Parameters: pRegion  - the render region to export to. [INPUTS] pDc - device context to use, can be NULL. VisibleLayersOnly - use visible layers or not ShowProgress - TRUE then start up a progress bar or FALSE assume the caller has done it. Returns: TRUE if the export process completed successfully, FALSE if an error occured. See also: Filter::ExportRender, Filter::ExportRenderNodes Reimplemented from Filter. Definition at line 790 of file ai_eps.cpp. { BOOL success = FALSE; #ifdef DO_EXPORT // Find the first node that we should export from this spread AIEPSRenderRegion *pAIEPSRR = static_cast<AIEPSRenderRegion*> ( pRegion ); Spread *pSpread = pRegion->GetRenderSpread (); Layer *pLayer = static_cast<Layer*> ( pSpread->FindFirstChild ( CC_RUNTIME_CLASS ( Layer ) ) ); Node *pBGNode = NULL; // Set the background colour. DocColour bg(FlashFilter::GetPageColour ( pSpread, &pBGNode ) ); pRegion->SetBackgroundColour ( bg ); // Export the file, but catch any file errors. try { // (ChrisG 5/4/2001) Find the first non-guide layer. while (pLayer && pLayer->IsGuide ()) { pLayer = pLayer->FindNextLayer (); } // Export the layer and all the nodes if one is found. if (pLayer) { // Export the layer. pAIEPSRR->StartLayer ( pLayer ); // Invoke the base class WriteNodes function. success = Filter::WriteNodes ( pRegion, pDC, VisibleLayersOnly, CheckSelected, ShowProgress ); } } // TRY catch ( CFileException) { // Didn't work - report failure to caller. if ( pDC ) pDC->ExportFile->SetThrowExceptions ( FALSE ); pRegion->StopRender (); if ( ShowProgress ) EndSlowJob (); success = FALSE; } #endif return success; }

---

Member Data Documentation

CommandMap AIEPSFilter::AICommands [static, protected]

Initial value: { { EPSC_z, _T("z")}, { EPSC_e, _T("e")}, { EPSC_T, _T("T")}, { EPSC_t, _T("t")}, { EPSC_Invalid, _T("Invalid") } } Definition at line 156 of file ai_eps.h.

BOOL AIEPSFilter::bDoClip [protected]

Definition at line 158 of file ai_eps.h.

---

The documentation for this class was generated from the following files:

• Kernel/ai_eps.h (r1785/r1312)
• Kernel/ai_eps.cpp (r1785/r1314)

---