SGLibOil Class Reference

Initially, general OILy utilities for the library, but then the Add Library dialog code was added in... More...

#include <sgliboil.h>

Inheritance diagram for SGLibOil:

List of all members.

Public Member Functions
	SGLibOil ()
	~SGLibOil ()
Static Public Member Functions
static BOOL	FileCopy (PathName *Source, PathName *Destination)
	Copies a file from source to destination. Notes: This function was deemed necessary as actually doing this sort of thing in windows 3.1 is completely nasty, and completely incompatible with NT's way...
static BOOL	FileExists (PathName *FileName)
	To find out whether a file actually exists. Notes:.
static INT32	FileSize (PathName *FileName)
	To find out whether a file actually exists. Notes:.
static BOOL	FileDelete (PathName *FileName)
	Delete a file - scarry ! Notes:.
static UINT32	FileModified (PathName *FileName)
	Return numeric form of last modified time / date... for a file.
static BOOL	DirExists (const PathName &FileName)
	To find out whether a dir actually exists. Notes:.
static BOOL	IsRootDirectory (String_256 *Path)
	Checks if root directory or not... `.
static void	AppendSlashIfNotPresent (String_256 *Str)
	Checks if the string has a slash on the end, and appends one if not.
static DWORD	GetDriveSerialNumber (String_256 *PathStr)
	Obtains a serial number for the drive hosting the given pathname. Theoretically CD's all contain unique serial numbers, so we can use this to check for new CD's in the drive, etc...
static BOOL	LocateCDROMDrive (LibraryGallery *LG, SGLibType LibType, String_256 *DriveName, BOOL *OnXaraNet, String_256 *XaraMount, BOOL AdjustPressed=FALSE)
	Looks for the Xara CD. At present we go through all their CDROM drives checking for the existance of certain directories on the CDs... We also check the various net points for the Xara CD test library...
static BOOL	MakeSound (PathName *WaveFile)
	Processes messages from the Explorer version of the common File Open dialog. Used to kill the get path dbox when OK is clicked, handling 'Generate' clicks, and re-arranging the window's items...Plays a wave file through the computer's sound system (if it has one).
static BOOL	PlayRandomSample (String_256 *SampleString, String_256 *SubPath)
	Plays a random wave file through the computer's sound system (if it has one).
static BOOL	GetLibPath (LibraryGallery *LG, PathName *Path, BOOL CanGenerate, SGLibType Type, BOOL *Updated=NULL)
static BOOL	GenerateClicked (LibraryGallery *LG, PathName *GenDirectory)
static BOOL	CheckForIndex (String_256 *Path, LibraryGallery *ParentGallery)
static BOOL	LoadSoundDefinition (CXaraFileRecordHandler *pXFileRecHandler, CXaraFile *pCXFile, INT32 Tag, UINT32 Size, UINT32 RecordNumber)
static BOOL	ExportWav (BaseCamelotFilter *pFilter)
static BOOL	TidyUp (void)
	Called by camelot de-init routines.
Static Public Attributes
static BOOL	UseExplorerForAdd
Static Protected Member Functions
static UINT32 CALLBACK	FileHook (wxWindow *hDlg, UINT32 Msg, UINT32 wParam, INT32 lParam)
	Processes messages from the common File Open dialog. Used to kill the get path dbox when OK is clicked. Used for handling 'Generate' clicks. Notes:.
Static Protected Attributes
static BOOL	SearchButtonClicked
static String_256	SearchDirectory
static String_256	BrowsePath
static SGLibType	LibType
static LibraryGallery *	ParentLibraryGallery
static BOOL	GenerateButtonClicked
static TCHAR *	TmpSndName = NULL

---

Detailed Description

Initially, general OILy utilities for the library, but then the Add Library dialog code was added in...

Author:

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

Date:

8/3/95

Definition at line 229 of file sgliboil.h.

---

Constructor & Destructor Documentation

SGLibOil::SGLibOil (   )  [inline]

Definition at line 234 of file sgliboil.h. {}

SGLibOil::~SGLibOil (   )  [inline]

Definition at line 235 of file sgliboil.h. {}

---

Member Function Documentation

void SGLibOil::AppendSlashIfNotPresent (  String_256 *  Str  )  [static]

Checks if the string has a slash on the end, and appends one if not. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 15/2/96 Parameters: Str  - String to append slash to [INPUTS] Str  - String with slash appended [OUTPUTS] Definition at line 2874 of file sgliboil.cpp. { ERROR3IF(Str == NULL, "SGLibOil::AppendSlashIfNotPresent given a NULL string"); if(Str == NULL) return; if(Str->Length() > 0) if( ((TCHAR *)*Str)[Str->Length()-1] != '/' ) *Str += TEXT("/"); }

static BOOL SGLibOil::CheckForIndex (  String_256 *  Path, LibraryGallery *  ParentGallery )  [static]

BOOL SGLibOil::DirExists (  const PathName &  FileName  )  [static]

To find out whether a dir actually exists. Notes:. Author: Luke Hart (Xara Group Ltd) <lukeh@xara.com> Date: 21/05/06 Parameters: File  - Pointer to path and filename of dir [INPUTS] Returns: Returns true if the specified dir exists Definition at line 1311 of file sgliboil.cpp. { return wxDir::Exists( PCTSTR(FileName.GetPath()) ); #if 0 CCDiskFile File; BOOL OldTEState = File.SetThrowExceptions(FALSE); BOOL OldREState = File.SetReportErrors(FALSE); BOOL Found = FALSE; // Open file - returns false if there was an error (file doesn't exist) Found = File.open(FileName->GetPath(), ios::in | ios::binary | ios::nocreate); if(Found) File.close(); File.SetThrowExceptions(OldTEState); File.SetReportErrors(OldREState); Error::ClearError(); return Found; #endif }

BOOL SGLibOil::ExportWav (  BaseCamelotFilter *  pFilter  )  [static]

Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 14/2/96 Parameters: pFilter  - Filter point to which we want the data streaming [INPUTS] Returns: TRUE if the record was succesfully exported; FALSE if not Definition at line 2806 of file sgliboil.cpp. { #if 0 BOOL ok = TRUE; INT32 RecordNumber = pFilter->StartStreamedRecord(TAG_DEFINESOUND_WAV, CXF_UNKNOWN_SIZE); // If we had a problem starting the record up then exit now if (RecordNumber <= 0) return RecordNumber; PathName Source("C:\\sample.wav"); INT32 Size = SGLibOil::FileSize(&Source); void *Buffer = CCMalloc(Size + 4); if(Buffer != NULL) { CCDiskFile File(1024, FALSE, TRUE); // Open file and check if it exists at the same time TRY { // Read file into the buffer File.open(Source.GetPath(), ios::in | ios::binary | ios::nocreate); File.read(Buffer, Size); if(File.isOpen()) File.close(); // Write file from buffer into output file //pOutput->write(Buffer, Size); for(INT32 i=0; i<Size; i++) pFilter->Write(((BYTE *)Buffer)[i]); } CATCH( CFileException, e) { // File not copied ok... Clear the errors and fall though to alternative low- // memory file copy... (this should be very rare !) Error::ClearError(); } END_CATCH CCFree(Buffer); } // Ask for the record to be ended and hence items like the size in the record header // to be cleaned up and hence made correct if (ok) ok = pFilter->EndStreamedRecord(); return ok; #else return FALSE; #endif }

BOOL SGLibOil::FileCopy (  PathName *  Source, PathName *  Destination )  [static]

Copies a file from source to destination. Notes: This function was deemed necessary as actually doing this sort of thing in windows 3.1 is completely nasty, and completely incompatible with NT's way... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 28/3/95 Parameters: Source  - Source path to grab file from [INPUTS] Destination - Destination path to copy file to Returns: Returns true if all was hunky dorey Definition at line 1146 of file sgliboil.cpp. { PORTNOTETRACE("dialog","SGLibOil::FileCopy - do nothing"); #ifndef EXCLUDE_FROM_XARALX if(Source == NULL || Destination == NULL) { ERROR3("SGLibOil::FileCopy Source or Destination files should not be null"); return FALSE; } if(!Destination->IsValid() || !Source->IsValid()) { ERROR3("SGLibOil::FileCopy given invalid path"); return FALSE; } if(FileExists(Destination)) { ERROR3("SGLibOil::FileCopy destination file already exists"); return FALSE; } if(!FileExists(Source)) { ERROR3("SGLibOil::FileCopy source file doesn't exist"); return FALSE; } // ************************* // return CopyFile((TCHAR *)Source->GetPath(), (TCHAR *)Destination->GetPath(), FALSE); // ************************* INT32 Size = SGLibOil::FileSize(Source); void *Buffer = CCMalloc(Size + 4); if(Buffer != NULL) { CCDiskFile File(1024, FALSE, TRUE); // Open file and check if it exists at the same time try { // Read file into the buffer File.open( Source->GetPath(), ios::in | ios::binary ); File.read( Buffer, Size ); if(File.isOpen()) File.close(); // Write file from buffer into output file File.open(Destination->GetPath(), ios::out | ios::binary); File.write(Buffer, Size); if(File.isOpen()) File.close(); CCFree(Buffer); // File copied ok... return TRUE; } catch( CFileException ) { // File not copied ok... Clear the errors and fall though to alternative low- // memory file copy... (this should be very rare !) Error::ClearError(); } CCFree(Buffer); } // ************************* // Not enough memory available, do the copy the old, slow, byte by byte (ANSI) way... FILE *FPin = NULL; FILE *FPout = NULL; #if defined(__WXMSW__) FPin = _tfopen((const TCHAR *)Source->GetPath(), "rb"); FPout = _tfopen((const TCHAR *)Destination->GetPath(), "wb"); #else PSTR pszSrc, pszDst; { size_t cchTmp = camWcstombs( NULL, Source->GetPath(), 0 ) + 1; pszSrc = PSTR( alloca( cchTmp ) ); camWcstombs( pszSrc, Source->GetPath(), cchTmp ); } { size_t cchTmp = camWcstombs( NULL, Destination->GetPath(), 0 ) + 1; pszDst = PSTR( alloca( cchTmp ) ); camWcstombs( pszDst, Destination->GetPath(), cchTmp ); } FPin = fopen( pszSrc, "rb" ); FPout = fopen( pszDst, "wb" ); #endif if(FPin != NULL || FPout != NULL) { TCHAR C; while(!feof(FPin)) { C = _fgettc(FPin); if(!feof(FPin)) _fputtc(C, FPout); } fclose(FPin); fclose(FPout); return TRUE; } if(FPin != NULL) fclose(FPin); if(FPout != NULL) fclose(FPout); #endif return FALSE; }

BOOL SGLibOil::FileDelete (  PathName *  FileName  )  [static]

Delete a file - scarry ! Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 29/3/95 Parameters: File  - Pointer to path and filename of file [INPUTS] Returns: Returns true if the specified file was deleted ok Definition at line 1385 of file sgliboil.cpp. { PORTNOTETRACE("dialog","SGLibOil::FileDelete - do nothing"); #ifndef EXCLUDE_FROM_XARALX ERROR3IF(FileName == NULL || !FileName->IsValid(), "SGLibOil::FileDelete given a dodgy FileName"); // Check if it exists, if so, kill it... if( _taccess( (const TCHAR *)FileName->GetPath(), ios::in ) == 0 ) { // RemoveFile((TCHAR *)FileName->GetPath(), cmoVital | cmoForce); if(_tremove((const TCHAR *)FileName->GetPath()) == 0) return TRUE; } #endif return FALSE; }

BOOL SGLibOil::FileExists (  PathName *  FileName  )  [static]

To find out whether a file actually exists. Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 8/3/95 Parameters: File  - Pointer to path and filename of file [INPUTS] Returns: Returns true if the specified file exists Definition at line 1276 of file sgliboil.cpp. { return wxFile::Exists( PCTSTR(FileName->GetPath()) ); #if 0 CCDiskFile File; BOOL OldTEState = File.SetThrowExceptions(FALSE); BOOL OldREState = File.SetReportErrors(FALSE); BOOL Found = FALSE; // Open file - returns false if there was an error (file doesn't exist) Found = File.open(FileName->GetPath(), ios::in | ios::binary | ios::nocreate); if(Found) File.close(); File.SetThrowExceptions(OldTEState); File.SetReportErrors(OldREState); Error::ClearError(); return Found; #endif }

UINT32 CALLBACK SGLibOil::FileHook (  wxWindow *  pDlg, UINT32  Msg, UINT32  wParam, INT32  lParam )  [static, protected]

Processes messages from the common File Open dialog. Used to kill the get path dbox when OK is clicked. Used for handling 'Generate' clicks. Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 2/4/95 Parameters: hDlg  - HWND of the dialog box. [INPUTS] iMsg - UINT32 message number. wParam - UINT32 parameter. lParam - INT32 parameter. Returns: Non-Zero or Zero, indicating if the common dialog should SKIP the message (non-zero) or not (zero). Don't confuse with typical dialog box return values. Definition at line 1743 of file sgliboil.cpp. { PORTNOTETRACE("dialog","SGLibOil::FileHook - do nothing - window CB"); #ifndef EXCLUDE_FROM_XARALX switch(Msg) { case WM_INITDIALOG: { #ifdef STANDALONE // Remove the Help button on standalone builds... HWND hGadget = GetDlgItem((HWND)hDlg, (INT32)_R(IDC_LIBPATH_HELP_BUTTON)); ShowWindow(hGadget, SW_HIDE); #endif // We need to apply the correct font if we are in DBCS land if (UnicodeManager::IsDBCSOS()) FontFactory::ApplyFontToWindow(hDlg, STOCKFONT_DIALOG); } return TRUE; case WM_COMMAND: switch(wParam) { case _R(IDC_LIBPATH_HELP_BUTTON): // Special check for the help button, and a bodgy way of invoking help for // this dialog, which is a generic CFileDialog type with a custom template, // and thus has no unique class-name. _HelpUser(TEXT("SGalleryAddFolderDlg")); return TRUE; case IDOK: // Close the dbox when Add pressed PostMessage(GetParent(hDlg), WM_COMMAND, IDOK, (INT32)FALSE); return FALSE; case _R(IDC_LIBPATH_GENERATE): // Since there's no way of getting the full pathname here, we simulate // a click on 'OK' to close the dbox, and set a flag saying we've clicked // 'Generate' instead, so the code after the DoModal can get the proper // path, generate the index, and re-open the dbox. Talk about a bodge ! SGLibOil::GenerateButtonClicked = TRUE; PostMessage(hDlg, WM_COMMAND, IDOK, (INT32)FALSE); return FALSE; case _R(IDC_LIBPATH_SEARCH): // Scan (Search) for some clipart { if(!SGLibOil::ParentLibraryGallery->ScanForLocation(SGLibOil::LibType, &SGLibOil::SearchDirectory)) { // Keep the dialog open - don't change the path INT32 ButtonPressed = InformWarning(_R(IDS_LIBRARY_BROWSING_CANT_FIND_LIBRARY), _R(IDS_OK)); Error::ClearError(); return FALSE; } DirPath Path(SGLibOil::SearchDirectory); if(!Path.IsValid()) { ERROR3("Scanned to path is invalid"); // Keep the dialog open - don't change the path return FALSE; } // Remember the pathname and which button was clicked so we can update the dialog SGLibOil::SearchButtonClicked = TRUE; PostMessage(hDlg, WM_COMMAND, IDOK, (INT32)FALSE); return FALSE; } default: break; } break; default: return FALSE; } #endif return FALSE; }

UINT32 SGLibOil::FileModified (  PathName *  FileName  )  [static]

Return numeric form of last modified time / date... for a file. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 6/1/95 Parameters: FileName  - Pointer to path and filename of file [INPUTS] Returns: Returns a numeric value relating the last time the file was modified. Old files will always return a lesser number than new ones. Definition at line 1414 of file sgliboil.cpp. { PORTNOTETRACE("dialog","SGLibOil::FileModified - do nothing"); #ifndef EXCLUDE_FROM_XARALX ERROR3IF(FileName == NULL, "SGLibOil::FileModified given a NULL FileName"); ERROR3IF(!FileName->IsValid(), "SGLibOil::FileModified given invalid path"); struct _tstat buf; INT32 Result = _tstat((const TCHAR *)FileName->GetPath(), &buf); if(Result != 0) return 0; // some files seem to have dates of -1, which is a long time in the future, or basically // random... We assume they haven't been modified recently... if(buf.st_mtime == -1) return 0; return (UINT32)buf.st_mtime; #else return 1; #endif }

INT32 SGLibOil::FileSize (  PathName *  FileName  )  [static]

To find out whether a file actually exists. Notes:. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 28/3/95 Parameters: File  - Pointer to path and filename of file [INPUTS] Returns: Returns true if the specified file exists Definition at line 1346 of file sgliboil.cpp. { PORTNOTETRACE("dialog","SGLibOil::FileSize - do nothing"); #ifndef EXCLUDE_FROM_XARALX ERROR3IF(FileName == NULL, "SGLibOil::FileSize Filename should not be null"); ERROR3IF(!FileName->IsValid(), "SGLibOil::FileSize given invalid path"); INT32 FileSize = 0; // Unfortunately MFC seems to have a nasty bug which is less than useful // WRT reading file sizes of old files... We resort to good old c. FILE *FP = NULL; FP = _tfopen((const TCHAR *)FileName->GetPath(), "rb"); if(FP != NULL) { fseek(FP,0,SEEK_END); FileSize = ftell(FP); fclose(FP); } return FileSize; #else return 1; #endif }

static BOOL SGLibOil::GenerateClicked (  LibraryGallery *  LG, PathName *  GenDirectory )  [static]

DWORD SGLibOil::GetDriveSerialNumber (  String_256 *  PathStr  )  [static]

Obtains a serial number for the drive hosting the given pathname. Theoretically CD's all contain unique serial numbers, so we can use this to check for new CD's in the drive, etc... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 17/7/96 Parameters: PathStr  - Pathname string containing drive, etc [INPUTS] Returns: Serial number for given pathname's drive, or 0 if there were problems Definition at line 2902 of file sgliboil.cpp. { TRACE( wxT("Warning - SGLibOil::GetDriveSerialNumber called\n") ); #if defined(__WXMSW__) if(PathStr == NULL) return 0; TCHAR Drive[MAX_PATH]; BOOL driveFound = FALSE; // Just for safety String_256 Path = *PathStr; const TCHAR *fn; fn = Path; BOOL BadCharacter = FALSE; // First check if there is a valid drive name or net drive name present // If the first character of the path is an alpha then assume drive and check if valid // and so of the form D:/ // Otherwise, check for a UNC (Universal naming convention) form of drive of the form // //Deepthought if (String::IsAlpha(*fn)) driveFound = getDrive(&fn, Drive); // Parse the Drive else driveFound = getNetDrive(&fn, Drive, &BadCharacter); //Parse as UNC or network drive if(driveFound && !BadCharacter) { String_256 FileSystemName; String_256 VolumeName; DWORD SerialNumber = 0; BOOL bRC = FALSE; bRC=GetVolumeInformation(Drive, (TCHAR *)VolumeName, 255, &SerialNumber, NULL, NULL, (TCHAR *)FileSystemName, 255); if(bRC) return SerialNumber; } return 0; #else return 0x00BAD000; #endif }

static BOOL SGLibOil::GetLibPath (  LibraryGallery *  LG, PathName *  Path, BOOL  CanGenerate, SGLibType  Type, BOOL *  Updated = NULL )  [static]

BOOL SGLibOil::IsRootDirectory (  String_256 *  Path  )  [static]

Checks if root directory or not... `. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 14/2/96 Parameters: Path  - Path string -> "A:\" or "C:\fred" [INPUTS] Returns: TRUE if the path describes a root directory -> "A:\" or "\\deepthought\materials", "\\fred\fred\", etc... Definition at line 2672 of file sgliboil.cpp. { TRACE( wxT("Warning - SGLibOil::PlayRandomSample called\n") ); #if defined(__WXMSW__) ERROR3IF(Path == NULL, "SGLibOil::IsRootDirectory given a NULL string"); if(Path == NULL) return FALSE; // ERROR3_PF(("IsRootDirectory -> %s", (TCHAR *)*Path)); // Remove trailing '\'s String_256 TmpPath(*Path); if(TmpPath[TmpPath.Length()-1] == _T('\\')) Path->Left(&TmpPath, Path->Length()-1); // Check for 'a:'s... if( TmpPath.Length() == 2 && TmpPath[1] == _T(':') ) return TRUE; // ERROR3_PF(("For %s, Sub = %d, Count = %d", (TCHAR *)TmpPath, TmpPath.Sub(String_8("\\\\"), 0, TCHAR('*')), TmpPath.CountChar('\\'))); // Check if unc root dir if( ( TmpPath.Sub( String_8( wxT("\\\\") ), 0, wxT('*') ) == 0 && TmpPath.CountChar( wxT('\\') ) <= 3 ) ) { // ERROR3("UNC root"); return TRUE; } // ERROR3_PF(("%s is not a root", (TCHAR *)*Path)); return FALSE; #else return FALSE; #endif }

BOOL SGLibOil::LoadSoundDefinition (  CXaraFileRecordHandler *  pXFileRecHandler, CXaraFile *  pCXFile, INT32  Tag, UINT32  Size, UINT32  RecordNumber )  [static]

Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 14/2/96 Parameters: pXFileRecHandler  - The CXaraFileRecordHandler that is being used to provide read functions etc. [INPUTS] pCXFile - The CXaraFile that is being used to provide read functions etc. Tag - The tag of the record and hence the type of file being imported Size - The size of this record RecordNumber - The record number for this record Returns: TRUE if the record was succesfully imported; FALSE if not (e.g. out of memory) Definition at line 2724 of file sgliboil.cpp. { TRACE( wxT("Warning - SGLibOil::LoadSoundDefinition called\n") ); #if defined(__WXMSW__) if(TmpSndName != NULL) { PathName TheFile(TmpSndName); FileDelete(&TheFile); TmpSndName = NULL; } // Create a temporary filename to use if(( TmpSndName = _ttmpnam( NULL ) ) != NULL ) { UINT32 Size = pCXFile->GetCurrentRecordSize(); CCFile *pRecordFile = pCXFile->GetCCFile(); void *Buffer = CCMalloc(Size + 4); BOOL ok = FALSE; if(Buffer != NULL) { CCDiskFile File(1024, FALSE, TRUE); // Open file and check if it exists at the same time try { // Read file into the buffer pRecordFile->read(Buffer, Size); // Write file from buffer into output file PathName OutputPath(TmpSndName); File.open(OutputPath, ios::out | ios::binary); File.write(Buffer, Size); if(File.isOpen()) File.close(); // File copied ok... ok = TRUE; } catch( CFileException ) { // File not copied ok... Clear the errors and fall though to alternative low- // memory file copy... (this should be very rare !) Error::ClearError(); } CCFree(Buffer); } if(ok) { ok = PlaySound((TCHAR *)TmpSndName, NULL, SND_ASYNC | SND_NODEFAULT | SND_NOWAIT | SND_FILENAME); if(!ok) ok = sndPlaySound((TCHAR *)TmpSndName, SND_ASYNC | SND_NODEFAULT | SND_NOWAIT | SND_FILENAME); } /* PathName TheFile(TmpSndName); FileDelete(&TheFile);*/ } return TRUE; #else return FALSE; #endif }

BOOL SGLibOil::LocateCDROMDrive (  LibraryGallery *  LG, SGLibType  LibType, String_256 *  DriveName, BOOL *  OnXaraNet, String_256 *  XaraMount, BOOL  AdjustPressed = FALSE )  [static]

Looks for the Xara CD. At present we go through all their CDROM drives checking for the existance of certain directories on the CDs... We also check the various net points for the Xara CD test library... Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 6/4/95 Parameters: LG  - parent library gallery for function [INPUTS] LibType - the type of library we're looking for AdjustPressed - Is 'adjust' held down ? DriveName  will return a string such as "D:\" for the last valid CD drive it [OUTPUTS] found with any of the magic directories present. OnXaraNet will return TRUE if we found a camelot CD mount was point XaraMount will return the path of the dummy CD -> "g:\CD\" Returns: Returns true if a CD Drive or Xara mount was found Notes: The internal network drive matching code uses the serial number of the drive itself. If we change the Xara CamelotCD mount point we'll need to change the serial number stuff below... Definition at line 1466 of file sgliboil.cpp. { #if !defined(__WXMSW__) TRACE( _T("Warning - SGLibOil::FileModified called") ); return FALSE; #else if(!LG || !DriveName || !OnXaraNet || !XaraMount) { ERROR3("SGLibOil::LocateCDROMDrive given null input stuff"); return FALSE; } BOOL FoundCD = FALSE; BOOL FoundXara = FALSE; BOOL FoundProgramMount = FALSE; *OnXaraNet = FALSE; DWORD dwTemp; const DWORD DriveStringBufferSize = 20480; TCHAR DriveStringBuffer[DriveStringBufferSize]; TCHAR *lpszDriveStringBuffer = (TCHAR *)DriveStringBuffer; TCHAR RootPathName[] = { '?', ':', chPathSep, 0 }; String_64 SlowJob(_R(IDS_LIBRARIES_FINDING_CD)); BeginSlowJob(('z' - 'a'), FALSE, &SlowJob); DWORD dwDriveMask=GetLogicalDrives(); DWORD dwRC=GetLogicalDriveStrings(DriveStringBufferSize, lpszDriveStringBuffer); //ERROR3IF(dwRC == 0, "SGLibOil::LocateCDROMDrive - RC == 0 (no worries, we can default to plan b !)"); ERROR3IF(dwDriveMask == 0, "SGLibOil::LocateCDROMDrive - DriveMask == 0 - this means you haven't got any drives at all on your system !!!"); if(dwRC == 0) { memset(DriveStringBuffer, 0, DriveStringBufferSize); INT32 i = 0; for(*RootPathName='a'; *RootPathName<='z'; (*RootPathName)++) { DriveStringBuffer[i] = *RootPathName; DriveStringBuffer[i + 1] = ':'; DriveStringBuffer[i + 2] = chPathSep; DriveStringBuffer[i + 3] = 0; i += 4; } dwRC = i; dwDriveMask = 0xffffffff; } if(dwRC != 0 && dwDriveMask != 0) { // Loop through all the drives for(*RootPathName='a'; *RootPathName<='z'; (*RootPathName)++) { if(!ContinueSlowJob(*RootPathName - 'a')) { *RootPathName = 'z'; } else { dwTemp=dwDriveMask & 1; dwDriveMask >>= 1; if (dwTemp) { // finds out what sort of drive this is dwRC=GetDriveType(RootPathName); switch (dwRC) { case DRIVE_REMOTE: #ifdef SCANFORXARAMOUNT { TRACEUSER( "Richard", wxT("The drive type for %s is remote\n"), lpszDriveStringBuffer); // See if we're on the Xara Net or not... String_256 FileSystemName; String_256 VolumeName; DWORD SerialNumber = 0; BOOL bRC; bRC=GetVolumeInformation(RootPathName, (TCHAR *)VolumeName, 255, &SerialNumber, NULL, NULL, (TCHAR *)FileSystemName, 255); if(bRC) { TRACEUSER( "Richard", wxT("%d - %s - %s\n"), SerialNumber, (TCHAR *)VolumeName, (TCHAR *)FileSystemName); BOOL FoundAPossibleMount = FALSE; // Programs mount if( (SerialNumber == (DWORD)0x589c1e6f) && (VolumeName == (String_256)"") && (FileSystemName == (String_256)"NTFS") ) { FoundProgramMount = TRUE; } if(!AdjustPressed) { // \\jimpc\corelxra if( (SerialNumber == 0x6863b85e) && (VolumeName == (String_256)"CORELXARA") && (FileSystemName == (String_256)"CDFS") ) { FoundAPossibleMount = TRUE; } } // \\earth\materials if(AdjustPressed) { if( (SerialNumber == 0xec29b7f6) && (VolumeName == (String_256)"") && (FileSystemName == (String_256)"NTFS") ) { FoundAPossibleMount = TRUE; } } if(FoundAPossibleMount) { // OK, but are we the proper drive ? String_256 CDPath(lpszDriveStringBuffer); String_256 CheckPath(lpszDriveStringBuffer); if(AdjustPressed) { switch(LibType) { case SGLib_ClipArt: case SGLib_ClipArt_WebThemes: CheckPath += TEXT("Graphics\\XaraSt~1"); break; case SGLib_Font: CheckPath += TEXT("Fonts"); break; case SGLib_Texture: CheckPath += TEXT("Graphics\\Fills"); break; default: CheckPath += TEXT("Fills\\Fabric"); break; } } else CheckPath += TEXT("Fills\\Fabric"); if(_taccess((TCHAR *)CheckPath, ios::in ) == 0) { String_256 Drive(CDPath); SGLibOil::AppendSlashIfNotPresent(&Drive); *XaraMount = Drive; *OnXaraNet = TRUE; FoundXara = TRUE; } } } else { DWORD Problem = GetLastError(); TRACEUSER( "Richard", wxT("GetVolumeInformation returned %d error"), Problem); } } #endif break; case DRIVE_CDROM: // Since autochangers seem to take a seemingly endless amount of time to swap through // each disk, so I've added this check to see if we've already found the CD or not... if(!FoundCD) { String_256 CDPath(lpszDriveStringBuffer); String_256 LibDirName; PORTNOTE("dialog","Removed LibraryGallery usage") #ifndef EXCLUDE_FROM_XARALX LG->GetLibraryDirectoryName(&LibDirName); #endif CDPath += LibDirName; if( 0 == _taccess( (TCHAR *)CDPath, ios::in ) ) { FoundCD = TRUE; *DriveName = lpszDriveStringBuffer; } // Bodge for Viewer CD, which contains a hidden Fills directory // If this ever moves, the below code will need to be changed if(!FoundCD && LibType == SGLib_Texture) { CDPath = (String_256)lpszDriveStringBuffer; CDPath += TEXT("Clipart\\Clipart\\"); CDPath += String_16(_R(IDS_LIBRARIES_XARAINFO_DIRNAME)); CDPath += TEXT("\\"); CDPath += String_16(_R(IDS_LIBRARIES_FILLS_DIRNAME)); if(_taccess((TCHAR *)CDPath, ios::in ) == 0) { FoundCD = TRUE; *DriveName = lpszDriveStringBuffer; *DriveName += TEXT("Clipart\\Clipart\\"); *DriveName += String_16(_R(IDS_LIBRARIES_XARAINFO_DIRNAME)); *DriveName += TEXT("\\"); } } } break; case DRIVE_REMOVABLE: TRACEUSER( "Richard", wxT("The drive type for %s is removable\n"), lpszDriveStringBuffer); break; case DRIVE_FIXED: TRACEUSER( "Richard", wxT("The drive type for %s is fixed\n"), lpszDriveStringBuffer); // Maybe we should be recursing through their hard drive looking for XaraInfo // directories ? v2 probably... break; case DRIVE_RAMDISK: TRACEUSER( "Richard", wxT("The drive type for %s is ramdisk\n"), lpszDriveStringBuffer); break; default: break; } // Advance to next valid drive in system lpszDriveStringBuffer = lpszDriveStringBuffer + camStrlen(lpszDriveStringBuffer) + 1; } } } } EndSlowJob(); #ifdef _DEBUG if(!FoundCD && !FoundXara && FoundProgramMount) { String_256 XaraMsg; XaraMsg = "You're connected to the Xara Net, but not the CamelotCD mount, so can't 'find' the library. "; ERROR3(XaraMsg); } #endif return (FoundCD || FoundXara); #endif }

BOOL SGLibOil::MakeSound (  PathName *  WaveFile  )  [static]

Processes messages from the Explorer version of the common File Open dialog. Used to kill the get path dbox when OK is clicked, handling 'Generate' clicks, and re-arranging the window's items...Plays a wave file through the computer's sound system (if it has one). Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 2/1/96 Parameters: WaveFile  - Full filename of .wav file [INPUTS] [OUTPUTS]  Returns: TRUE if played ok... Definition at line 2558 of file sgliboil.cpp. { #if defined(__WXMSW__) // Actually play the sound String_256 File(WaveFile->GetPath()); BOOL ok = PlaySound((TCHAR *)File, NULL, SND_ASYNC | SND_NODEFAULT | SND_NOWAIT | SND_FILENAME); if(!ok) ok = sndPlaySound((TCHAR *)File, SND_ASYNC | SND_NODEFAULT | SND_NOWAIT | SND_FILENAME); return ok; #else TRACE( wxT("Warning - SGLibOil::MakeSound called\n") ); return TRUE; #endif }

BOOL SGLibOil::PlayRandomSample (  String_256 *  SampleString, String_256 *  SubPath )  [static]

Plays a random wave file through the computer's sound system (if it has one). Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 2/1/96 Parameters: SampleString  - String such as "Fish.wav|fred.wav|C:\tmp.wav" [INPUTS] SubPath - Path to append to file -> C: Returns: TRUE if item found and played ok... Definition at line 2590 of file sgliboil.cpp. { #if defined(__WXMSW__) String_256 SoundToUse(*SampleString); if(SoundToUse.Length() > 2) { // Pick a random sound from a line such as "Frog.wav|fish.wav|water.wav" INT32 Fields = SampleString->CountChar('|'); if(Fields > 0) { INT32 Count = (rand()%(Fields+1))+1; String_256 TmpSoundToUse(SoundToUse); if(Count > 0) { TCHAR *Start = (TCHAR *)*SampleString; TCHAR *Finish = Start + SampleString->Length(); // char to look for const TCHAR BAR = '|'; TCHAR Ch = *Start; INT32 FieldCount = 1; // scan through fields until we hit our baby while(Count > FieldCount && Start < Finish) { if(Ch == 0) break; if(Ch == BAR) FieldCount ++; Start += sizeof(TCHAR); Ch = *Start; } // Pointer to sound to use if(Count == FieldCount) TmpSoundToUse = Start; } // Strip any trailing sounds if(TmpSoundToUse.Sub(String_8(_T("|"))) != -1) TmpSoundToUse.Left(&SoundToUse, TmpSoundToUse.Sub(String_8(_T("|")))); else SoundToUse = TmpSoundToUse; } // Path for normal files is with the pictures if(SoundToUse.Sub(String_8(_T("\\"))) == -1) { String_256 File = *SubPath; SGLibOil::AppendSlashIfNotPresent(&File); File += SoundToUse; SoundToUse = File; } PathName SoundPath(SoundToUse); return SGLibOil::MakeSound(&SoundPath); } return FALSE; #else TRACE( wxT("Warning - SGLibOil::PlayRandomSample called\n") ); return TRUE; #endif }

BOOL SGLibOil::TidyUp (  void   )  [static]

Called by camelot de-init routines. Definition at line 1119 of file sgliboil.cpp. { if(TmpSndName != NULL) { PathName TheFile(TmpSndName); FileDelete(&TheFile); TmpSndName = NULL; } return TRUE; }

---

Member Data Documentation

String_256 SGLibOil::BrowsePath [static, protected]

Definition at line 265 of file sgliboil.h.

BOOL SGLibOil::GenerateButtonClicked [static, protected]

Definition at line 268 of file sgliboil.h.

SGLibType SGLibOil::LibType [static, protected]

Definition at line 266 of file sgliboil.h.

LibraryGallery* SGLibOil::ParentLibraryGallery [static, protected]

Definition at line 267 of file sgliboil.h.

BOOL SGLibOil::SearchButtonClicked [static, protected]

Definition at line 263 of file sgliboil.h.

String_256 SGLibOil::SearchDirectory [static, protected]

Definition at line 264 of file sgliboil.h.

TCHAR * SGLibOil::TmpSndName = NULL [static, protected]

Definition at line 269 of file sgliboil.h.

BOOL SGLibOil::UseExplorerForAdd [static]

Definition at line 272 of file sgliboil.h.

---

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

• wxOil/sgliboil.h (r1785/r1282)
• wxOil/sgliboil.cpp (r1785/r1664)

---