SimpleCCObject Class Reference

Override new and delete, so that new returns NULL when no more memory is available, rather than throwing an exception. More...

#include <ccobject.h>

Inheritance diagram for SimpleCCObject:

List of all members.

Public Member Functions
void *	operator new (size_t, void *p)
void *	operator new (size_t nSize)
	This function allocates a block of memory to create a new SimpleCCObject derived thingy. This does not throw an exception, but returns NULL in the event of a failure. In debug builds it also keeps track of all allocations and will give a dump of all reamining blobs of memory when camelot exits.
void	operator delete (void *p)
	I think you can work this one out! In debug builds this will also remove items from the memory tracking list.
void *	operator new (size_t nSize, LPCSTR lpszFileName, INT32 nLine)
	This functions adds an item into the memory tracking list and stores the filename and line number if it is passed in. Both versions of new call this function to handle all there DEBUG stuff.A version of the new operator that stores the filename etc into the memory tracking structure to help in debugging. This can be activated by including the following line :- MonoOn define new CAM_DEBUG_NEW MonoOff after all the IMPLEMENT_DYNAMIC() etc macros.
Static Public Member Functions
static void	MemoryTrackAdd (void *p, LPCSTR Filename, INT32 Line)
static void	MemoryDump ()
	Dumps the details of all objects allocated at the time of the call to the Debug window.
static BOOL	Init ()
	Declares a preference that allows you to clear memory in delete().

---

Detailed Description

Override new and delete, so that new returns NULL when no more memory is available, rather than throwing an exception.

Author:

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

Date:

15/7/93

NB. ALL Camelot objects not derived from OIL class libraries should be be derived from SimpleCCObject in some way, be it directly, or via CCObject. This is so they don't throw exceptions if we try to create them and there is not enough memory.

See also:

-

Definition at line 180 of file ccobject.h.

---

Member Function Documentation

BOOL SimpleCCObject::Init (  void   )  [static]

Declares a preference that allows you to clear memory in delete(). Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 19/4/94 Returns: TRUE if it worked OK, FALSE if not Reimplemented in AboutDlg, AI5EPSFilter, AI8EPSFilter, AIEPSFilter, PhotoShopEPSFilter, ArrangeAlignment, OpAlign, AppPrefsDlg, OptionsTabs, GIFAnimationPropertyTabsDlg, GIFAnimationPropertyTabs, FramePropertiesTab, AnimationPropertiesTab, AnimationColoursTab, PreviewInBrowserTab, AnimExOptns, OpApplyAttribToSelected, OpApplyAttrInteractive, OpApplyAttribsToSelected, OpRepeatApplyAttribToSelected, OpApplyAttribToNode, OpReplaceAttributes, BevelAttributeValueIndent, BevelAttributeValueLightAngle, BevelAttributeValueContrast, BevelAttributeValueType, BevelAttributeValueLightTilt, LineWidthAttribute, StartArrowAttribute, EndArrowAttribute, StartCapAttribute, JoinTypeAttribute, MitreLimitAttribute, WindingRuleAttribute, DashPatternAttribute, ArtWorksEPSFilter, OpBackground, BarCreationDlg, BarStatesDlg, BarRedefineStateDlg, DialogBarOp, SystemBarOp, BaseDocument, BitmapEffectBase, BfxOp, BfxDlg, BfxPlugInDlg, BfxHandler, BfxPlugInOp, BfxPlugInUndoOp, CBiasGainDlg, BaseBitmapFilter, OILBitmap, BlobbyOp, BlobbyDlg, BlobbyBar, BlobbyTabDlg, BmapPrevDlg, BitmapListComponentClass, BitmapExportPreviewDialog, GlobalBitmapList, OpDeleteBitmap, BitmapExportOptions, BmpPrefsDlg, PhotoCDDlg, BmpDlg, BrushAttrValue, BrushComponentClass, CNameBrushDlg, CInitBrushNameDlg, CBrushEditDlg, CamelotEPSFilter, BaseCamelotFilter, CDRFilter, ClipRegionAttribute, CMXFilter16, CMXFilter32, CMXImportFilter, CMXTreeDlg, ColourListComponentClass, ColourContext, ColourEditDlg, OpMakeColourLocalToFrame, OpColEditCommand, ColourManager, OpHideColours, OpColourChange, OpRedrawColours, OpCombineShapes, MSPaletteFilter, PaintShopProPaletteFilter, AdobeColourTableFilter, AdobeColourSwatchFilter, CorelPaletteFilter, JCWColourFilter, CorelEPSFilter, Corel3EPSFilter, Corel4EPSFilter, OpCreateFontThumbnails, OpConvertFileFormats, OpCut, OpCopy, OpPaste, OpPasteAttributes, OpDelete, OpDuplicate, OpClone, OpCopyAndTransform, CXFTreeDlg, DaveDlg, OpBevel, OpURLImport, DebugTreeDlg, DocView, OpToggleFore, OpToggleScroll, OpToggleSolidDrag, AcornDrawFilter, EditSelectionOp, EPSFilter, JPEGExportFilter, ExpressView, ExtendSetsDlg, FileListOp, AttrFillGeometry, OpFillNudge, ColourFillAttribute, TranspFillAttribute, FillMappingAttribute, FillEffectAttribute, TranspFillMappingAttribute, StrokeColourAttribute, StrokeTranspAttribute, MouldAttribute, Filter, GenericFilter, VectorFilterFamily, BitmapFilterFamily, GenericEPSFilter, PaletteFilterFamily, ImagemapFilter, ImagemapRenderRegion, ImagemapDlg, FileInfo, FontComponentClass, FontManager, GlobalFractalList, OpGrabFrame, FreeHandEPSFilter, FlareTemplateFilter, FeatherAttrValue, GDrawAsm, OpGroup, OpUngroup, OpUngroupSpecial, OpGuideline, OpNewGuideline, OpSpreadOrigin, OpResetSpreadOrigin, GuidelinePropDlg, WebAddressDlg, HotKey, JPEGImportFilter, ColourImportContext, ImportedColours, OpMenuImport, OpMenuExport, OpDroppedFile, DownloadOp, OpAsynchFontInstall, OpAsynchBitmapImport, OpThumbDownload, OpAsynchClipartImport, OpAddWebFolders, OpAddWebLibrary, InfoBarOp, InfoBarViewOp, DocInfoComponentClass, NodeRenderableInk, OverprintLineAttrValue, OverprintFillAttrValue, PrintOnAllPlatesAttrValue, OpChangeLineJoinOpDesc, OpChangeLineCapOpDesc, Layer, LayerDlg, OpLayerGalChange, LayerNameDlg, OpDisplayLayerGallery, OpDisplayFrameGallery, OpLayerChange, OpMoveToLayer, LayerPropertyTabsDlg, LayerPropertyTabs, OpConvertToBitmap, OpExit, OpRegister, OpUpdate, DocOps, MenuPopupOps, OpToolSelect, HelpOps, WindowOps, ViewOps, DummyOp, OpMakeShapes, OpMakeNodesShapes, OpMakeStroke, OpDragOrigin, NameDialog, CamelotNativeFilter, OpMenuLoad, OpMenuSave, OpSaveAsNativeV1, CamelotNativeEPSFilter, NewColourDlg, NameObjectsDlg, OpDisplayNameGallery, NodeRenderableBounded, OpCreateNodeBitmap, NodeBitmapEffect, VisibleTextNode, AbstractTextChar, TextLine, BaseTextClass, TextStory, ObjectRegistry, OpBarCreation, OpBreakAtPoints, OpDragBox, OpDuplicateBar, OpShortenBar, OpDelBar, OpShowState, OpChangeFeatherSize, OpChangeFeatherProfile, OpCreateFill, OpEditFill, OpUndo, OpRedo, OpShowPrinterColours, OpToggleCompositePreview, OpToggleCyanPreview, OpToggleMagentaPreview, OpToggleYellowPreview, OpToggleKeyPreview, OpToggleSpotPreview, OpToggleMonoPlatePreview, OpOverprintLine, OpOverprintFill, OpPrintOnAllPlates, OpNudge, OpPullOntoGrid, OpSmoothSelection, OpEditRectangle, EditTab, GridTab, OpGridResize, MiscTab, PageTab, OpPageResize, PlugInsTab, PointersTab, SepsDlg, OpShowPrintBorders, ScaleTab, TuneTab, UndoTab, UnitsTab, UnitPropertiesDlg, ViewTab, OpWhatsThis, OpNodePathEditBlob, OpNodePathEditControlBlob, OpNodePathAddEndpoint, OpCloseNodePaths, OpReshapeOrAddPoint, OpNewPath, OpToggleSmooth, OpJoinShapes, OpBreakShapes, OpDeletePoints, OpPathNudge, OpMakeSegmentsLines, OpMakeSegmentsCurves, OpMovePathPoint, OpMenuSelectPathPoints, OpReversePath, OpPenCreateInternal, OpPenEditInternal, OpPenEditPath, OpPenCreatePath, OpPenAddElement, OpPenClosePath, OpAddNewPath, OpAddPathToPath, OpClosePathWithPath, PlugInHandler, PlugInManager, PlugInOp, PlugInUndoOp, Preferences, PreviewDialog, PrintComponentClass, OpPrint, PrintMarkComponentClass, PrintPrefsDlg, PropertyTabs, GuidesPropertiesTab, OpChangeLayerColour, LayerPropertiesTab, PreviewFilter, PreviewFilterBMP, PreviewFilterGIF, PreviewFilterJPEG, PreviewFilterPNG, OpPreviewPopupCommand, QualityAttribute, OpQuality, RenderDemoDlg, RenderRegion, OpRetroSmooth, EPSRenderRegion, SelectAllOp, SelectNoneOp, SelMediaDlg, SGalleryOptionsDlg, SGallerySortDlg, SGallerySearchDlg, OpDisplayTEMPLATEGallery, OpDisplayBitmapGallery, ColourSGallery, OpDisplayColourGallery, ColourNameDlg, LibClipartSGallery, OpDisplayLibClipartGallery, LibFillsSGallery, OpDisplayLibFillsGallery, LineGallery, OpDisplayLineGallery, OpDisplayNameGallery, NameObjectsDlg, OpEditRegularShape, OpDragRegularShape, OpReformShapeEdge, OpShapeToggleElipPoly, OpShapeToggleCurvature, OpShapeToggleStellation, OpShapeToggleSetNumSides, OpShapeMakeRegular, OpSlice, OpShowGrid, OpSnapToGrid, OpSnapToObjects, OpSnapToGuides, OpShowGuides, StandardBar, StrokeTypeAttrValue, VariableWidthAttrValue, StrokeComponentClass, Styles, WizOpStyleComponentClass, FlashFilter, TipsDlg, TemplateDialog, ToolbarDlg, ToolnameDlg, CustomizeBarDlg, TraceOp, TraceDlg, TraceBoundaryPoint, TxtFontTypefaceAttribute, TxtFontSizeAttribute, TxtBoldAttribute, TxtItalicAttribute, TxtUnderlineAttribute, TxtJustificationAttribute, TxtTrackingAttribute, TxtAspectRatioAttribute, TxtScriptAttribute, TxtBaseLineAttribute, TxtLineSpaceAttribute, TxtRulerAttribute, TxtLeftMarginAttribute, TxtRightMarginAttribute, TxtFirstIndentAttribute, UnitListComponentClass, Unit, DocUnitList, URLImportDlg, OpURLImport, UserAttribute, ValueFunction, VectorFileRenderRegion, ViewComponentClass, WebAddressAttribute, CamelotWebFilter, OpSaveAsWeb, OpSaveAsNativeV2, WebPrefsDlg, NativePrefsDlg, XSEPSExportOptions, OpBringToFront, OpPutToBack, OpMoveForwards, OpMoveBackwards, OpMoveToLyrInFront, OpMoveToLyrBehind, OpCombineLayersToFrameLayer, OpCreateNewMould, OpRemoveMould, OpCopyMouldShape, OpPasteEnvelope, OpPastePerspective, OpToggleMouldGrid, OpDetachMould, OpRotateMould, OpRectangularEnvelope, OpRectangularPerspective, OpSelectPathPoints, OpApplyClipView, OpRemoveClipView, OpLiveEffect, OpRetroFit, TextInfoBarOp, TabStopDragOp, OpFitTextToCurve, OpTextKern, OpTextAutoKern, OpTextPaste, OpTogglePrintTextAsShapes, OpDeleteTextStory, OpReverseStoryPath, OpApplyJustificationToStory, OpTextSelection, OpDragStoryPathLeftIndent, OpDragStoryPathRightIndent, OpDragStoryNonPathLeftIndent, OpDragStoryNonPathRightIndent, OpAffectFontChange, OpZoomIn, OpZoomOut, OpZoomTo100, OpZoomTo200, OpZoomTo300, OpZoomTo400, BfxALU, BMPFilter, CamProfile, CamResource, OpClipboardExport, OpClipboardImport, ClipboardView, PasteSpecialDlg, DimScale, BarTable, ControlHelper, ControlTable, ControlList, DialogView, BitmapDragInformation, ColourDragInformation, ColourPickerDragInformation, OpException, OpGBrush, GDrawContext, OpGenericDownload, TI_GIFFilter, GRenderRegion, OpGDraw, HelpDownloadOp, HelpDownloadDlg, OpBitmapDownload, ImageMagickFilter, MaskedFilter, MetaFileFilter, MetafileView, OSRenderRegion, CCPen, OpTogglePressure, PNGFilter, BasePMFilter, PPMFilter, PGMFilter, PBMFilter, PrintProgressDlg, OpToggleDoubleBuffer, OpDisplayFontsGallery, OpClipartImport, OpBitmapImport, SGalleryLinePropertiesDlg, LibSettings, OpTimeDraw, OpClearCache, OpThrottleCache, and StringVar. Definition at line 191 of file ccobject.cpp. { // return TRUE as we do not want Camelot to fail to start over this return TRUE; }

void SimpleCCObject::MemoryDump (   )  [static]

Dumps the details of all objects allocated at the time of the call to the Debug window. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 15/7/93 Definition at line 660 of file ccobject.cpp. { #ifdef _DEBUG // somewhere to hold the output string TCHAR OutputMsg[256]; // Get a pointer to the head of the list of memory items MemTrackExtra *pItem = pHead; if( pItem != NULL ) TRACE( _T("......Memory Leaks Detected......\n")); // loop through it while( pItem != NULL ) { PORTNOTE("other","Removed MFC CDumpContext") #ifndef EXCLUDE_FROM_XARALX ((CCObject*)(pItem->Start))->Dump(afxDump); #endif #if 0 != wxUSE_UNICODE TCHAR pFilename[22]; camMbstowcs(pFilename, pItem->Filename, 22); #else TCHAR* pFilename = pItem->Filename; #endif camSnprintf( OutputMsg, 256, _T("allocated in %s at line %d.\n"), pFilename, pItem->LineNum ); TRACE(OutputMsg); // Get the next one along pItem = pItem->pNext; if (pItem==NULL) TRACE( _T("\n......End Of Memory Dump......\n")); } #endif }

static void SimpleCCObject::MemoryTrackAdd (  void *  p, LPCSTR  Filename, INT32  Line )  [static]

void SimpleCCObject::operator delete (  void *  p  )

I think you can work this one out! In debug builds this will also remove items from the memory tracking list. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 15/7/93 Parameters: p  - pointer to the block of mem to free [INPUTS] Returns: Errors: Asserts if it discovers that the block you are trying to delete has already been deleted, never existed or is otherwise not valid. Definition at line 575 of file ccobject.cpp. { // behave like normal delete if (p==NULL) return; #ifdef _DEBUG // TRACE( _T("SimpleCCObject::delete at 0x%08x (0x%08x)\n"),p, ((char*)p) - sizeof(MemTrackExtra)); // Get the real start of the block p = ((char*)p) - sizeof(MemTrackExtra); // find out how big the block is #if !defined(__WXMAC__) size_t BlockLen = _msize(p); #else size_t BlockLen = malloc_size(p); #endif #ifdef _OUTPUT_DEBUG TotalMemAllocated -= BlockLen; TRACE( _T("DeAllocated %ld\n"),TotalMemAllocated); #endif // Find the start of my strange structure MemTrackExtra* pExtraInfo = (MemTrackExtra*)p; // make sure that the guard word is still there if (pExtraInfo->GuardWord == GUARDWORD) { // yep, all seems well, so remove this item from the list // Update the head of the list if needed if (pExtraInfo == pHead) pHead = pExtraInfo->pNext; // Update the next item in the list if (pExtraInfo->pNext!=NULL) pExtraInfo->pNext->pPrev = pExtraInfo->pPrev; // update the previous item in the list if (pExtraInfo->pPrev!=NULL) pExtraInfo->pPrev->pNext = pExtraInfo->pNext; // Write over the block with the dead memory land fill value memset(p, OLDLANDFILL, BlockLen); // Destroy the guard word pExtraInfo->GuardWord = DEADGUARD; } else { if (pExtraInfo->GuardWord == DEADGUARD) ENSURE(FALSE, "Memory was de-alloced more than once...\n"); // Debug else ENSURE(FALSE, "ALERT!!!! Memory Tracker thinks that memory is toast...\n"); // Debug // either way, the memory is not there to be freed return; } #endif // free up the allocation free(p); #ifdef _DEBUG // and check everything is OK if (CHECK_MEMORY) CheckMemory( TRUE ); #endif }

void * SimpleCCObject::operator new (  size_t  Size, LPCSTR  FileName, INT32  Line )

This functions adds an item into the memory tracking list and stores the filename and line number if it is passed in. Both versions of new call this function to handle all there DEBUG stuff.A version of the new operator that stores the filename etc into the memory tracking structure to help in debugging. This can be activated by including the following line :- MonoOn define new CAM_DEBUG_NEW MonoOff after all the IMPLEMENT_DYNAMIC() etc macros. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 23/7/93 Parameters: size  - Number of bytes required [INPUTS] FileName - The name of the file that caused the allocation Line - The line number in the file that caused the allocation Returns: a pointer to the allocated block of memory, or NULL if the allocation failed Reimplemented in DownloadOpParam. Definition at line 408 of file ccobject.cpp. { // First we have to make a note of the function pointer maintained by VC++ thats // called by malloc if it fails (as it currently throws an exception) // We have to set it to NULL to stop malloc doing anything when mem runs out #if !defined(__WXMAC__) _PNH old_handler = _set_new_handler( NULL ); #else new_handler pnh = set_new_handler(NULL); #endif #ifdef _OUTPUT_DEBUG TotalMemAllocated += Size; TRACE( _T("Allocated %ld\n"),TotalMemAllocated); #endif #ifdef _DEBUG // We actually want more memory to build our list out of Size += sizeof(MemTrackExtra); #endif void* pStart = NULL; // See if we are supposed to fail this memory claim for low memory simulation #ifdef _DEBUG if (FailingMemory) { if (Size < BytesBeforeFail) BytesBeforeFail -= Size; else goto Allocated; } #endif // ask for the actual memory pStart = malloc(Size); // finally repair the function pointer to its old value and return our pointer #if !defined(__WXMAC__) _set_new_handler( old_handler ); #else set_new_handler(pnh); #endif // Do lots of tracking if in Debug mode #ifdef _DEBUG if (pStart!=NULL) { // Build in all the extra memory tracking info that we like to have MemoryTrackAdd(pStart, FileName, Line); } Allocated: // We'll remove the label as well (to get rid of the warning) #endif // if the pointer is NULL then we should set the error handler if (pStart==NULL) { TRACE( wxT("ALERT! ALERT! new is about to return NULL, Watch out for unhandled errors\n") ); Error::SetError(_R(IDS_OUT_OF_MEMORY)); } // TRACE( _T("SimpleCCObject::new at 0x%08x (0x%08x)\n"),((char*)pStart) + sizeof(MemTrackExtra), pStart); #ifdef _DEBUG // return the pointer to the space after our tracking info return (((char*)pStart) + sizeof(MemTrackExtra)); #else // return the real start of the block return (pStart); #endif }

void * SimpleCCObject::operator new (  size_t  Size  )

This function allocates a block of memory to create a new SimpleCCObject derived thingy. This does not throw an exception, but returns NULL in the event of a failure. In debug builds it also keeps track of all allocations and will give a dump of all reamining blobs of memory when camelot exits. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 15/7/93 Parameters: size  - The number of bytes to allocate [INPUTS] Returns: a pointer to the allocated memory (or NULL if the allocation failed) See also: SimpleCCObject::delete; SimpleCCObject::MemoryDump Reimplemented in DownloadOpParam. Definition at line 499 of file ccobject.cpp. { // First we have to make a note of the function pointer maintained by VC++ thats // called by malloc if it fails (as it currently throws an exception) // We have to set it to NULL to stop malloc doing anything when mem runs out #if !defined(__WXMAC__) _PNH old_handler = _set_new_handler( NULL ); #else new_handler pnh = set_new_handler(NULL); #endif #ifdef _DEBUG // We actually want more memory to build our list out of Size += sizeof(MemTrackExtra); #endif #ifdef _OUTPUT_DEBUG TotalMemAllocated += Size; TRACE( _T("Allocated %ld\n"),TotalMemAllocated); #endif // ask for the actual memory void* pStart = malloc(Size); // finally repair the function pointer to its old value and return our pointer #if !defined(__WXMAC__) _set_new_handler( old_handler ); #else set_new_handler(pnh); #endif // Do lots of tracking if in Debug mode #ifdef _DEBUG // see if we have a NULL value returned from new if (pStart!=NULL) { // Build in all the extra memory tracking info that we like to have MemoryTrackAdd(pStart, NULL, 0); } #endif // if the pointer is NULL then we should set the error handler if (pStart==NULL) { TRACE( wxT("ALERT! ALERT! new is about to return NULL, Watch out for unhandled errors\n") ); Error::SetError(_R(IDS_OUT_OF_MEMORY)); } // TRACE( _T("SimpleCCObject::new at 0x%08x (0x%08x)\n"),((char*)pStart) + sizeof(MemTrackExtra), pStart); #ifdef _DEBUG // return the pointer to the space after our tracking info return (((char*)pStart) + sizeof(MemTrackExtra)); #else // return the real start of the block return (pStart); #endif }

void* SimpleCCObject::operator new (  size_t  , void *  p )  [inline]

Definition at line 188 of file ccobject.h. { return p; }

---

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

• wxOil/ccobject.h (r1785/r751)
• wxOil/ccobject.cpp (r1785/r1464)

---