StrokeComponent Class Reference

A document component for handling Stroke definitions. More...

#include <strkcomp.h>

Inheritance diagram for StrokeComponent:

List of all members.

Public Member Functions
	StrokeComponent ()
	Constructor.
virtual	~StrokeComponent ()
	Destructor.
virtual BOOL	StartImport (BaseCamelotFilter *pFilter)
	Called before we start to import a file.
virtual BOOL	EndImport (BaseCamelotFilter *pFilter, BOOL Success)
	Called on completion of an import.
virtual BOOL	StartExport (BaseCamelotFilter *pFilter)
	Called before an export is started.
virtual BOOL	EndExport (BaseCamelotFilter *pFilter, BOOL Success)
	Called on completion of file export.
Static Public Member Functions
static StrokeHandle	AddNewStroke (StrokeDefinition *pStroke)
	Adds the given stroke to the global stroke list.
static StrokeDefinition *	FindStroke (StrokeHandle Handle)
	Find a stroke, given its unique identity handle.
static BOOL	StartImportStroke (CamelotRecordHandler *pHandler, CXaraFileRecord *pRecord)
	To import a vector stroke definition.
static BOOL	EndImportStroke (CamelotRecordHandler *pHandler)
	To import a vector stroke definition.
static StrokeHandle	FindImportedStroke (UINT32 ImportedHandle)
	To match up a handle from the currently importing file to the real internal StrokeHandle of the imported StrokeDefinition.
static BOOL	ExportStroke (BaseCamelotFilter *pFilter, StrokeHandle Handle)
	To export a vector stroke definition.
Static Protected Member Functions
static void	DeleteStrokeList (void)
	Static deinitialisation function, called on shutdown. Clears out the global stroke list. Must be called when all users of the stroke system (documents) have already been deleted.
Static Private Member Functions
static BOOL	ExpandArray (void)
	(Internal method) Expands the storage structure of the stroke list to allow more entries to be used. Called automatically by AddNewStroke as necessary.
Static Private Attributes
static StrokeDefinition **	pStrokeList = NULL
static UINT32	CurrentSize = 0
static UINT32	Used = 0
static UINT32	ImportHandle = 0
static UINT32	ImportFlags = 0
static UINT32	ImportData1 = 0
static UINT32	ImportData2 = 0
static InsertTreeContext *	pImportPreviousContext = NULL
static Node *	pImportNewBrush = NULL
static String_32	ImportedName
Friends
class	StrokeComponentClass
class	StrokeDefinition

---

Detailed Description

A document component for handling Stroke definitions.

Author:

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

Date:

22/2/97

StrokeComponents share a global cache of available stroke types. Individual instances serve as managers for the list, mainly providing import/export facilities for stroke definitions.

See also:

DocComponent

Definition at line 266 of file strkcomp.h.

---

Constructor & Destructor Documentation

StrokeComponent::StrokeComponent (   )

Constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/2/97 Definition at line 487 of file strkcomp.cpp. { }

StrokeComponent::~StrokeComponent (   )  [virtual]

Destructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/2/97 Definition at line 504 of file strkcomp.cpp. { }

---

Member Function Documentation

StrokeHandle StrokeComponent::AddNewStroke (  StrokeDefinition *  pStroke  )  [static]

Adds the given stroke to the global stroke list. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/2/97 Parameters: pStroke  - (may not be NULL) A stroke definition to add, which now [INPUTS] belongs to the StrokeComponent, so you mustn't delete it! Returns: A handle which uniquely identifies the new stroke, or StrokeHandle_NoStroke if we ran out of memory for storing strokes Notes: IMPORTANT! The stroke definition you pass in belongs to the StrokeComponent, and will be deleted when finished with. YOU MUST NOT use the pStroke pointer after this call! If the call fails, or if the stroke is merged with an existing one, the object you passed in will be IMMEDIATELY DELETED! If you wish to use the stroke after Adding it, you must call FindStroke with the returned stroke handle! Technical: Strokes are recorded in an array of StrokeDefinition pointers. The StrokeHandle is just an index into this array, for fast lookup. When deleted, the array-entry is set NULL and never re-used, so that any handles floating around can be safely used (much better than getting IndexedColour deleted when in use errors, eh? ;-). New entries are thus always appended to the list. Definition at line 576 of file strkcomp.cpp. { // ****!!!!TODO - if we're multi-threadig, this probably needs to be a critical section // because the list is global ERROR3IF(pStroke == NULL, "Illegal NULL param"); // --- First, check if we can merge the given stroke with one already in the list for (UINT32 i = 0; i < Used; i++) { if (pStrokeList[i] != NULL && !pStroke->IsDifferent(pStrokeList[i])) { // The stroke is the same as one we already have in our stroke list, so we // delete the copy that was passed in, and return the existing ones handle // We copy the import handle value over, though, so that we don't "lose" // merged strokes during import! pStrokeList[i]->SetIOStore(pStroke->ReadIOStore()); delete pStroke; return((StrokeHandle) i); } } // --- Next, check if we have enough room in our stroke array to add a new entry to the end if (Used >= CurrentSize) { if (!ExpandArray()) { delete pStroke; return(StrokeHandle_NoStroke); } } // --- OK, we have a totally new stroke, so add it to the end of the list StrokeHandle NewHandle = (StrokeHandle) Used; pStrokeList[Used] = pStroke; Used++; // --- Now, make sure the stroke gallery display updates to show the new stroke // ****!!!!TODO - should notify the stroke gallery (broadcast a msg) so that it updates // I'll use a nasty bodgy direct call to the line gallery instead... eeek! { PathProcessorStrokeVector *pProcessor = new PathProcessorStrokeVector; if (pProcessor != NULL) { pProcessor->SetStrokeDefinition(NewHandle); PORTNOTE("other","Removed LineGallery usage") #ifndef EXCLUDE_FROM_XARALX StrokeTypeAttrValue *pStrokeAttr = new StrokeTypeAttrValue(pProcessor); if (pStrokeAttr != NULL) LineGallery::AddNewStrokeItem(pStrokeAttr); else delete pProcessor; #endif } } // --- And return the new handle return(NewHandle); }

void StrokeComponent::DeleteStrokeList (  void   )  [static, protected]

Static deinitialisation function, called on shutdown. Clears out the global stroke list. Must be called when all users of the stroke system (documents) have already been deleted. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/2/97 Definition at line 523 of file strkcomp.cpp. { if (pStrokeList != NULL) { for (UINT32 i = 0; i < Used; i++) { if (pStrokeList[i] != NULL) delete pStrokeList[i]; pStrokeList[i] = NULL; } CCFree(pStrokeList); pStrokeList = NULL; } }

BOOL StrokeComponent::EndExport (  BaseCamelotFilter *  pFilter, BOOL  Success )  [virtual]

Called on completion of file export. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/2/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to import a file. [INPUTS] Success - True if everything went swimmingly, False if just a clean up is required. Returns: TRUE if the component was able to end the exporting; FALSE if not (e.g. out of memory) Reimplemented from DocComponent. Definition at line 806 of file strkcomp.cpp. { BOOL ok = TRUE; TRACEUSER( "Diccon", _T("End Export Stroke Component\n")); #if !defined(EXCLUDE_FROM_RALPH) if (pFilter == NULL) { ERROR3("StrokeComponent::EndExport filter is null!"); return(ok); } if (!Success) // If we failed to export, then return immediately return(ok); #endif return(ok); }

BOOL StrokeComponent::EndImport (  BaseCamelotFilter *  pFilter, BOOL  Success )  [virtual]

Called on completion of an import. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/2/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to import a file. [INPUTS] Success - TRUE => The import was successful; FALSE => The import failed - abandon any changes. Returns: TRUE if the component was able to end the importing; FALSE if not (e.g. out of memory) Reimplemented from DocComponent. Definition at line 731 of file strkcomp.cpp. { return TRUE; }

BOOL StrokeComponent::EndImportStroke (  CamelotRecordHandler *  pHandler  )  [static]

To import a vector stroke definition. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 4/3/97 Parameters: pRecord  - The TAG_STROKEDEFINITION record to import [INPUTS] Returns: TRUE if Import was successful Definition at line 1028 of file strkcomp.cpp. { ERROR3IF(pImportPreviousContext == NULL, "EndImportStroke - something hasn't gone too well"); // Restore the previous import context node pHandler->RestoreInsertContext(pImportPreviousContext); pImportPreviousContext = NULL; // --- Now, convert all IndexedColours (which are document-dependent) into standalone DocColours // This wouldn't be necessary, except that the DocColours we saved have magically been turned // back into local Indexedcolours by the export/import process. // BLOCK { Node *pCurNode = pImportNewBrush->FindFirstDepthFirst(); Node *pNextNode; while (pCurNode !=NULL) { // We may be about to chop this node out of the tree, so get the next node now pNextNode = pCurNode->FindNextDepthFirst(pImportNewBrush); // Use to scan the colour fields of the attribute. if (pCurNode->IsAnAttribute()) { PORTNOTE("colourmanager","Removed ColourManager usage") #ifndef EXCLUDE_FROM_XARALX UINT32 Context = 0; NodeAttribute *pNodeAttr = (NodeAttribute *) pCurNode; // Get the next colour field from the attribute DocColour *pColour = pNodeAttr->EnumerateColourFields(Context++); while (pColour != NULL) { // For each colour field, make sure the colour is a local DocColour so that // the sub-tree is entirely stand-alone if (pColour->FindParentIndexedColour() != NULL) { ColourGeneric ColDef; ColourContext *cc = ColourManager::GetColourContext(pColour->GetColourModel()); ERROR3IF(cc == NULL, "Can't find colour context?!"); // Get the IndexedColour definition as a standalone colour definition cc->ConvertColour(pColour->FindParentIndexedColour(), &ColDef); // Make the DocColour into a simple standalone "lookalike" of the parent colour *pColour = DocColour(pColour->GetColourModel(), &ColDef); } pColour = pNodeAttr->EnumerateColourFields(Context++); } #endif } pCurNode = pNextNode; } } // Create a new stroke definition from the imported brush // Read the imported data from ImportFlags, ImportData1, ImportData2 // (Currently, we only handle the Repeating, Optimal Repeating and Number of Repeating flags) BOOL Repeating = ((ImportFlags & 0x100) != 0); INT32 Repeats = 0; // If repeating a certain number of times, get the number of times, else assume 0 - optimal if((ImportFlags & 0xff) == 2) Repeats = (INT32)ImportData1; StrokeDefinition *pNewStroke = new StrokeDefinition(pImportNewBrush, Repeating, Repeats); if (pNewStroke == NULL) return(FALSE); pNewStroke->SetOverrideFill((ImportFlags & 0x400) != 0); pNewStroke->SetOverrideTrans((ImportFlags & 0x800) != 0); // Remember the handle used for the stroke in the file with the stroke so that // we can map any incoming handles into the real handles we are using internally. pNewStroke->SetIOStore(ImportHandle & 0x00ffffff); // And set the stroke's name, if any was supplied if (!ImportedName.IsEmpty()) pNewStroke->SetStrokeName(&ImportedName); // And add/merge this stroke into our global list AddNewStroke(pNewStroke); return(TRUE); }

BOOL StrokeComponent::ExpandArray (  void   )  [static, private]

(Internal method) Expands the storage structure of the stroke list to allow more entries to be used. Called automatically by AddNewStroke as necessary. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 28/2/97 Parameters: On  succesful exit, the member array of StrokeDefinition pointers will be bigger [OUTPUTS] Returns: FALSE if it failed to allocate memory Notes: Internal storage is an array of pointers to StrokeDefinitions NULL pointers beyond (& including) "Used" indicate free slots. NULL pointers before "Used" indicate deleted strokes - these slots should NOT be re-used, as there may still be references to them in the system. Definition at line 1172 of file strkcomp.cpp. { // ****!!!!TODO - if we're multi-threading, this probably needs to be a critical section // because the list is global const INT32 AllocSize = CurrentSize + 64; if (pStrokeList == NULL) { pStrokeList = (StrokeDefinition **) CCMalloc(AllocSize * sizeof(StrokeDefinition *)); if (pStrokeList == NULL) return(FALSE); } else { // We have an array - we must make it larger StrokeDefinition **pNewBuf = (StrokeDefinition **) CCRealloc(pStrokeList, AllocSize * sizeof(StrokeDefinition *)); if (pNewBuf == NULL) return(FALSE); pStrokeList = pNewBuf; } // Success. Initalise all the new pointers to NULL for (UINT32 i = Used; i < CurrentSize; i++) pStrokeList[i] = NULL; // Update the current size value, and return success CurrentSize = AllocSize; return(TRUE); }

BOOL StrokeComponent::ExportStroke (  BaseCamelotFilter *  pFilter, StrokeHandle  Handle )  [static]

To export a vector stroke definition. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 4/3/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to export a file. [INPUTS] Handle - The stroke to be exported Returns: TRUE if export was successful FALSE if export was aborted - no error is set, as in this case, it usually means that the stroke has been deleted, and is being treated as an old-style line. In this case, the caller should simply not bother exporting the attribute using the stroke definition. Notes: Stroke definitions (like colours) are only saved out when a node in the tree is found which makes use of the stroke. You should call this function before exporting any attribute which uses the stroke definition. It automatically checks if the stroke has already been saved, and will not save the definition more than once. When saving your reference to the stroke, save out the stroke's Handle as it's unique ID word. Definition at line 855 of file strkcomp.cpp. { ERROR3IF(pFilter == NULL, "Illegal NULL params"); TRACEUSER( "Diccon", _T("Exporting Stroke\n")); // Find the stroke, and baulk if it's all gone wrong StrokeDefinition *pStroke = FindStroke(Handle); if (pStroke == NULL) { ERROR3("Attempt to save a deleted or non-existent stroke"); return(FALSE); } // Check if the definition has already been saved, in which case we don't need to do anything more if (pStroke->ReadIOStore()) return(TRUE); // We've got a stroke definition now, so let's chuck it out to the file BOOL ok = TRUE; CXaraFileRecord Rec(TAG_STROKEDEFINITION, TAG_STROKEDEFINITION_SIZE); if (ok) ok = Rec.Init(); if (ok) ok = Rec.WriteUINT32(Handle); UINT32 Flags = 0x200; // All vector strokes include a name (Named flag == 0x200) if (ok) { // Write the flags out. if (pStroke->IsRepeating()) // Repeating flag = 0x100 Flags |= 0x100; if (pStroke->OverrideFill()) // Fill override flag = 0x400 Flags |= 0x400; if (pStroke->OverrideTrans()) // Transparency override flag = 0x800 Flags |= 0x800; ok = Rec.WriteUINT32(Flags); } if (ok) { INT32 NumRepeats = 0; if(pStroke->IsRepeating()) { // Write the flags out. NumRepeats = pStroke->NumRepeats(); if(NumRepeats == 0) Flags |= 1; else Flags |= 2; } // Write Data1 - this contains the number of times the brush should repeat down the stroke ok = Rec.WriteUINT32(NumRepeats); } if (ok) ok = Rec.WriteUINT32(0); // Write Data2 - for now, this is always 0 if (ok && ((Flags & 0x200) != 0)) // Write the (optional) name field ok = Rec.WriteUnicode((TCHAR *)*(pStroke->GetStrokeName())); if (ok) pFilter->Write(&Rec); // And write out the record // Now, follow the definition record with the brush subtree if (ok) { Node *pNode = pStroke->GetStrokeTree(); // Find the root Spread if (pNode != NULL) pNode = pNode->FindFirstChild(); // Find the Layer if (pNode != NULL) pNode = pNode->FindFirstChild(); // Find the NodeGroup if (pNode == NULL) ok = FALSE; ERROR3IF(pNode == NULL || !pNode->IsCompound(), "Vector brush not in the format I expected"); // Write out the clipart subtree. We have to encapsulate it in DOWN and UP // records ourselves CXaraFileRecord DownRec(TAG_DOWN, 0); if (ok) pFilter->Write(&DownRec); ok = pFilter->WriteNodes(pNode); CXaraFileRecord UpRec(TAG_UP, 0); if (ok) pFilter->Write(&UpRec); } // Finally, mark this stroke as having been written out so we don't do it again if (ok) pStroke->SetIOStore(TRUE); return(ok); }

StrokeHandle StrokeComponent::FindImportedStroke (  UINT32  ImportedHandle  )  [static]

To match up a handle from the currently importing file to the real internal StrokeHandle of the imported StrokeDefinition. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 4/3/97 Parameters: Importedhandle  - The handle which is used in the file being imported [INPUTS] to reference the stroke. Returns: The StrokeHandle of the loaded stroke, or StrokeHandle_NoStroke if the stroke could not be found. Definition at line 1136 of file strkcomp.cpp. { ImportedHandle &= 0x00ffffff; // Only the bottom 24 bits are relevant for (UINT32 Index = 0; Index < Used; Index++) { if (pStrokeList[Index] != NULL && pStrokeList[Index]->ReadIOStore() == ImportedHandle) return((StrokeHandle)Index); } return(StrokeHandle_NoStroke); }

StrokeDefinition * StrokeComponent::FindStroke (  StrokeHandle  Handle  )  [static]

Find a stroke, given its unique identity handle. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/2/97 Parameters: Handle  - A handle which uniquely identifies the new stroke [INPUTS] Returns: A pointer to a StrokeDefinition for that Stroke. If the stroke has been deleted, NULL will be returned, in which case, you should gracefully degrade (by rendering an old style line in place of the stroke) Definition at line 657 of file strkcomp.cpp. { if (Handle == StrokeHandle_NoStroke) return(NULL); if (Handle >= Used) { ERROR3("Out of range stroke handle"); return(NULL); } return(pStrokeList[Handle]); }

BOOL StrokeComponent::StartExport (  BaseCamelotFilter *  pFilter  )  [virtual]

Called before an export is started. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/2/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to export a file. [INPUTS] Returns: TRUE if the component was able to prepare for exporting; FALSE if not (e.g. out of memory) Reimplemented from DocComponent. Definition at line 753 of file strkcomp.cpp. { #if !defined(EXCLUDE_FROM_RALPH) if (pFilter == NULL) { ERROR3("StrokeComponent::StartExport filter is null!"); return(TRUE); } TRACEUSER( "Diccon", _T("Start Export Stroke Component\n")); // ****!!!!TODO - if we're multi-threadig, this probably needs to be a critical section // because the list is global // Flag all strokes as not having been saved. When we save one, we set its flag so that // we don't try to save it a second time. if (pStrokeList != NULL) { for (UINT32 Index = 0; Index < Used; Index++) { if (pStrokeList[Index] != NULL) pStrokeList[Index]->SetIOStore(FALSE); } // Write out an atomic tag definition in front of the vector stroke definition. // ****!!!!TODO - This should really only be done just before we export the first // STROKEDEFINITION tag, but it is not properly supported by the export system as yet. BOOL ok = TRUE; CXaraFileRecord Rec(TAG_ATOMICTAGS, TAG_ATOMICTAGS_SIZE); if (ok) ok = Rec.Init(); if (ok) ok = Rec.WriteUINT32(TAG_STROKEDEFINITION); if (ok) pFilter->Write(&Rec); // And write out the record } #endif return(TRUE); }

BOOL StrokeComponent::StartImport (  BaseCamelotFilter *  pFilter  )  [virtual]

Called before we start to import a file. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/2/97 Parameters: pFilter  - the BaseCamelotFilter filter that is being used to import a file. [INPUTS] Returns: TRUE if the component was able to prepare for importing; FALSE if not (e.g. out of memory) See also: DocComponent Reimplemented from DocComponent. Definition at line 689 of file strkcomp.cpp. { if (pFilter == NULL) { ERROR3("StrokeComponent::StartImport filter is null!"); return(TRUE); } // Set the IOStore in all the strokes to 0xffffffff. During import, this entry is used // to map imported handles to the real handles they have been assigned. if (pStrokeList != NULL) { for (UINT32 Index = 0; Index < Used; Index++) { if (pStrokeList[Index] != NULL) pStrokeList[Index]->SetIOStore(0xffffffff); } } return(TRUE); }

BOOL StrokeComponent::StartImportStroke (  CamelotRecordHandler *  pHandler, CXaraFileRecord *  pRecord )  [static]

To import a vector stroke definition. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 4/3/97 Parameters: pRecord  - The TAG_STROKEDEFINITION record to import [INPUTS] Returns: TRUE if Import was successful Definition at line 966 of file strkcomp.cpp. { ImportHandle = 0xffffffff; ImportFlags = 0; ImportData1 = 0; ImportData2 = 0; pImportPreviousContext = NULL; pImportNewBrush = NULL; String_256 TempName; // Load the name into a nice large safe buffer // Import the data from the record if (!pRecord->ReadUINT32(&ImportHandle) || !pRecord->ReadUINT32(&ImportFlags) || !pRecord->ReadUINT32(&ImportData1) || !pRecord->ReadUINT32(&ImportData2)) { return(FALSE); } // If there is a name to be imported, read it as well if ((ImportFlags & 0x200) != 0 && !pRecord->ReadUnicode(&TempName)) return(FALSE); // We remember the imported flags and suchlike, which we will use in EndImportStroke. TempName.Left((StringBase *)&ImportedName, 31); // Create a spread and set up the import system to import the brush into it // If this fails, then it'll just find somewhere "sensible" to import into pImportNewBrush = new Spread; if (pImportNewBrush == NULL) return(FALSE); Layer *pBrushLayer = new Layer(pImportNewBrush, FIRSTCHILD, String_256(TEXT("Jason did this"))); if (pBrushLayer == NULL) { delete pImportNewBrush; pImportNewBrush = NULL; return(FALSE); } // Now, remember where we were importing into, and point the importer at our brush tree pImportPreviousContext = pHandler->GetInsertContext(); pHandler->SetInsertContextNode(pBrushLayer); return(TRUE); }

---

Friends And Related Function Documentation

friend class StrokeComponentClass [friend]

Definition at line 268 of file strkcomp.h.

friend class StrokeDefinition [friend]

Definition at line 269 of file strkcomp.h.

---

Member Data Documentation

UINT32 StrokeComponent::CurrentSize = 0 [static, private]

Definition at line 313 of file strkcomp.h.

UINT32 StrokeComponent::ImportData1 = 0 [static, private]

Definition at line 319 of file strkcomp.h.

UINT32 StrokeComponent::ImportData2 = 0 [static, private]

Definition at line 320 of file strkcomp.h.

String_32 StrokeComponent::ImportedName [static, private]

Definition at line 323 of file strkcomp.h.

UINT32 StrokeComponent::ImportFlags = 0 [static, private]

Definition at line 318 of file strkcomp.h.

UINT32 StrokeComponent::ImportHandle = 0 [static, private]

Definition at line 317 of file strkcomp.h.

Node * StrokeComponent::pImportNewBrush = NULL [static, private]

Definition at line 322 of file strkcomp.h.

InsertTreeContext * StrokeComponent::pImportPreviousContext = NULL [static, private]

Definition at line 321 of file strkcomp.h.

StrokeDefinition ** StrokeComponent::pStrokeList = NULL [static, private]

Definition at line 312 of file strkcomp.h.

UINT32 StrokeComponent::Used = 0 [static, private]

Definition at line 314 of file strkcomp.h.

---

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

• Kernel/strkcomp.h (r1785/r1282)
• Kernel/strkcomp.cpp (r1785/r1282)

---