pathname.cpp File Reference

(r1785/r1282)

#include "camtypes.h"

Go to the source code of this file.

Defines
#define	MAXDRIVE   3
#define	MAXNAME   8
#define	MAXNETNAME   256
#define	MAXEXT   16
#define	SEPARATOR   _T('/')
#define	FULLSTOP   '.'
#define	COLON   ':'
#define	END_OF_PATH   '\0'
#define	END_OF_STRING   '\0'
#define	SEPARATOR_SYM   "\\"
#define	FULLSTOP_SYM   "."
#define	COLON_SYM   ":"
#define	END_OF_PATH_SYM   "\0"
#define	NET_DRIVE_SYM   "\\\\"
Functions
	DECLARE_SOURCE ("$Revision: 1282 $")
void	AbbreviateName (LPTSTR lpszCanon, INT32 cchMax, BOOL bAtLeastName)
BOOL	getDrive (const TCHAR **fn, TCHAR *drive)
	Parses the Drive location of file. Scope: Private.
BOOL	getNetDrive (const TCHAR **fn, TCHAR *drive, BOOL *pBadCharacter)
	Parses the network Drive location of file and returns whether this was accomplished or not. The network name will consist of the server name followed by a mount point name. Scope: Private.
BOOL	getIdentifier (const TCHAR **fn, TCHAR *identifier, UINT32 MaxSize, BOOL *pBadCharacter)
	Parses file or directory identifier Scope: Private.
BOOL	getExtension (const TCHAR **fn, TCHAR *ext, UINT32 MaxSize, const TCHAR *StartOfPath)
	Parses from the specified position, which should be the last valid character on the pathname, backwards until we hit either:- a full stop, in which case we have a valid filename extension, which we return a path separator, in which case there is no extension the start of the pathname, in which case there is no extension. Scope: Private.
BOOL	getParentDirectory (const TCHAR **fn, TCHAR *directory, UINT32 MaxSize, const TCHAR *StartOfPath)
	Parses from the specified position, which should be something like the first valid character of the filename on the pathname, backwards until we hit either:- a path separator, in which case we return the found name as a possible directory the start of the pathname, in which case there is no directory name. Scope: Private.
BOOL	IsReservedChar (const TCHAR **fn)
	Checks if character passed in is a special character allowed in file names. No longer used. Scope: Private Checks if character passed in is a reserved character allowed in file names. Does not check for terminators which are allowed by the callers such as . and backslash. These characters are considered illegal when converting long to short filenames and so it would seem sensible to limit their use. Scope: Private.
BOOL	IsDeviceName (const String_256 &path)
	Parses a string representing a path and sees if it refers to a device name which would be illegal.

---

Define Documentation

#define COLON   ':'

Definition at line 126 of file pathname.cpp.

#define COLON_SYM   ":"

Definition at line 132 of file pathname.cpp.

#define END_OF_PATH   '\0'

Definition at line 127 of file pathname.cpp.

#define END_OF_PATH_SYM   "\0"

Definition at line 133 of file pathname.cpp.

#define END_OF_STRING   '\0'

Definition at line 128 of file pathname.cpp.

#define FULLSTOP   '.'

Definition at line 125 of file pathname.cpp.

#define FULLSTOP_SYM   "."

Definition at line 131 of file pathname.cpp.

#define MAXDRIVE   3

Definition at line 110 of file pathname.cpp.

#define MAXEXT   16

Definition at line 113 of file pathname.cpp.

#define MAXNAME   8

Definition at line 111 of file pathname.cpp.

#define MAXNETNAME   256

Definition at line 112 of file pathname.cpp.

#define NET_DRIVE_SYM   "\\\\"

Definition at line 134 of file pathname.cpp.

#define SEPARATOR   _T('/')

Definition at line 118 of file pathname.cpp.

#define SEPARATOR_SYM   "\\"

Definition at line 130 of file pathname.cpp.

---

Function Documentation

void AbbreviateName (  LPTSTR  lpszCanon, INT32  cchMax, BOOL  bAtLeastName )

DECLARE_SOURCE (  "$Revision: 1282 $"   )

BOOL getDrive (  const TCHAR **  fn, TCHAR *  drive )

Parses the Drive location of file. Scope: Private. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 12/5/93 Parameters: A  pointer to the pointer to the path string [INPUTS] drive  - the parsed Drive Letter [OUTPUTS] Returns: TRUE if parsed ok and false otherwise See also: PathName(); SetPath(); Returns: Errors: None Definition at line 1133 of file pathname.cpp. { UINT32 i = 0; if (String::IsAlpha(**fn)) { drive[i++] = **fn; // Parse Drive Letter (*fn)++; if (**fn == COLON) // Parse colon { drive[i++] = **fn; (*fn)++; if (**fn == SEPARATOR) // Parse slash { drive[i++] = **fn; (*fn)++; } else return FALSE; // Else Syntax error } else return FALSE; } else return FALSE; drive[i++] = END_OF_STRING; return TRUE; }

BOOL getExtension (  const TCHAR **  fn, TCHAR *  ext, UINT32  MaxSize, const TCHAR *  StartOfPath )

Parses from the specified position, which should be the last valid character on the pathname, backwards until we hit either:- a full stop, in which case we have a valid filename extension, which we return a path separator, in which case there is no extension the start of the pathname, in which case there is no extension. Scope: Private. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 12/5/93 Parameters: A  pointer to the pointer to the path string [INPUTS] MaxSize - the maximum size of a network drive name StartOfPath - a pointer to the start of the path string A  file extension [OUTPUTS] Returns: TRUE if parsed ok FALSE otherwise See also: PathName(); IsValidAndReturnInfo(); SetPath(); Returns: Errors: None Definition at line 1350 of file pathname.cpp. { UINT32 i = 0; // Search from the specified string end backwards until we find either:- // - a full stop indicating a valid extension // - a path separator indicating no file extension is present // - the start of the file indicating no file extension is present while ( (**fn != SEPARATOR) && // is not at a path separating character (**fn != FULLSTOP) && // is not at a full stop character (*fn != StartOfPath) && // is not at the start of the path string (i < MaxSize) // is not maximum size ) { i++; (*fn)--; } if (**fn != FULLSTOP) // if we are not at a full stop Then Syntax error return FALSE; // Make up the string that we are going to return // Do it this way as otherwise we would be adding the characters in backwards in the above // routine as we are scanning backwards! UINT32 position = 0; // Start at first character in the string (*fn)++; // Move to character after the full stop while (( i >= 0 ) && (**fn != END_OF_PATH)) { ext[position++] = **fn; // Add current character to File Extension (*fn)++; // Move to next character i--; // decrement extension letters count } ext[position++] = END_OF_STRING; // Set end of string return TRUE; }

BOOL getIdentifier (  const TCHAR **  fn, TCHAR *  identifier, UINT32  MaxSize, BOOL *  pBadCharacter )

Parses file or directory identifier Scope: Private. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 12/5/93 Parameters: A  pointer to the pointer to the path string [INPUTS] MaxSize - the maximum size of a network drive name A pointer to the current bad character flag A  file or directory identifier [OUTPUTS] A pointer to a potentially new state of the bad character flag which signals a bad/reserved character was found in the string Returns: TRUE if parsed ok FALSE otherwise See also: PathName(); SetPath(); Returns: Errors: None Definition at line 1280 of file pathname.cpp. { UINT32 i = 0; // While not a Separator or not EOF or Maximum size // Used to check for (String::IsAlphaNumeric(**fn) || IsSpecialChar(fn)) // to see if it was a valid character or not but this would not allow things like // spaces which are allowed under NT and Chicago. Reduce check to known problem // characters such as colons in the wrong place and '/'. // but must only flag this as an error and continue as we must have a filename at the // end so that a m4essage such as 'cannot open file: xxxxx.xx' can be shown by using // the GetFileName call. // Removed the FULLSTOP test as this was stopping directory names having full stops in while ( **fn != SEPARATOR && // If not a separator for next directory/filename **fn != END_OF_PATH && // and not terminator i < (MaxSize)) // is less than maximum name size { // Check if this is an illegal character for the filing system and if so // make a note and continue. if ( IsReservedChar(fn) ) { *pBadCharacter = TRUE; // Flag bad character found } identifier[i++] = **fn; // Parse the Identifier (*fn)++; } // if a valid identifier terminator found then return True // otherwise return False. // Do not stop on full stops as these are valid in directory names. if (**fn == SEPARATOR || **fn == END_OF_PATH) { if (**fn == SEPARATOR) { identifier[i++] = **fn; // Parse the Separator } identifier[i++] = END_OF_STRING; // Set end of string return TRUE; } else return FALSE; }

BOOL getNetDrive (  const TCHAR **  fn, TCHAR *  drive, BOOL *  pBadCharacter )

Parses the network Drive location of file and returns whether this was accomplished or not. The network name will consist of the server name followed by a mount point name. Scope: Private. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 3/9/93 Parameters: A  pointer to the pointer to the path string [INPUTS] A pointer to the current bad character flag state A  network drive Letter [OUTPUTS] A pointer to the potentially new bad character flag state Returns: TRUE if parsed ok FALSE otherwise See also: PathName(); SetPath(); Returns: Errors: None Definition at line 1185 of file pathname.cpp. { // Used for storing either <ServerName> or <DirectoryName> String_256 identifier; TCHAR* pId; UINT32 i = 0; if (**fn == SEPARATOR) // Parse '\\' bit { drive[i++] = **fn; (*fn)++; if (**fn == SEPARATOR) { drive[i++] = **fn; (*fn)++; identifier.Empty(); // We have a valid network name start // Parse Network drive name(s) if ( getIdentifier(&(*fn), identifier, MAXNETNAME, pBadCharacter) ) { pId = identifier; // Copy identifier into drive while (*pId != END_OF_STRING) { drive[i++] = *pId; pId++; } (*fn)++; identifier.Empty(); // We have a valid network drive name and so parse the mount point name if ( getIdentifier(&(*fn), identifier, MAXNETNAME, pBadCharacter) ) { pId = identifier; // Copy identifier into drive while (*pId != END_OF_STRING) { drive[i++] = *pId; pId++; } (*fn)++; drive[i++] = END_OF_STRING; // Everything has gone ok so now exit return TRUE; } else return FALSE; } else return FALSE; } else return FALSE; } else return FALSE; }

BOOL getParentDirectory (  const TCHAR **  fn, TCHAR *  directory, UINT32  MaxSize, const TCHAR *  StartOfPath )

Parses from the specified position, which should be something like the first valid character of the filename on the pathname, backwards until we hit either:- a path separator, in which case we return the found name as a possible directory the start of the pathname, in which case there is no directory name. Scope: Private. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/3/95 Parameters: A  pointer to the pointer to the path string [INPUTS] MaxSize - the maximum size of a network drive name StartOfPath - a pointer to the start of the path string The  parent directory name [OUTPUTS] Returns: TRUE if parsed ok FALSE otherwise See also: GetTruncatedPath(); Returns: Errors: None Definition at line 1410 of file pathname.cpp. { UINT32 i = 0; // Note where we are in the path const TCHAR* CurrentPosition = *fn; // If we are tsarting on a separator then skip it if (**fn == SEPARATOR) (*fn)--; // Search from the specified string end backwards until we find either:- // - a path separator indicating we have found a potential parent directory. // - the start of the file indicating no parent directory is present while ( (**fn != SEPARATOR) && // is not at a path separating character (*fn != StartOfPath) && // is not at the start of the path string (i < MaxSize) // is not maximum size ) { i++; (*fn)--; } if (**fn != SEPARATOR) // if we are not at a directory separator return FALSE; // Then Syntax error // Make up the string that we are going to return // Do it this way as otherwise we would be adding the characters in backwards in the above // routine as we are scanning backwards! UINT32 position = 0; // Start at first character in the string while (( i >= 0 ) && (*fn != CurrentPosition)) { directory[position++] = **fn; // Add current character to directory name (*fn)++; // Move to next character i--; // decrement directory name letters count } directory[position++] = END_OF_STRING; // Set end of string return TRUE; }

BOOL IsDeviceName (  const String_256 &  path  )

Parses a string representing a path and sees if it refers to a device name which would be illegal. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/5/93 Parameters: String  representing a pathname [INPUTS] None  [OUTPUTS] Returns: TRUE if the pathname is a device name or FALSE otherwise. Errors: None Definition at line 1568 of file pathname.cpp. { #if defined(__WXMSW__) const INT32 buffer_size = 256; TCHAR buffer[buffer_size]; // create buffer of characters // First use a Windows call to try and see if the pathname supplied is a // known device name. Use a 256 string as a buffer as not particular bothered // by what is returned, only if something is returned DWORD i; i = QueryDosDevice(path, buffer, buffer_size); // See if known Windows device name // returns i = number of characters supplied in pBuffer, if 0 then failed //TRACE( _T("QueryDosDevice returns %d\n"),i); if (i>0) return TRUE; // valid device name, therefore passes #endif // Check our pathname against some known basic names as a final check // Device names will in general have three letters with a possible number // and possible colon on the end. String_256 temp; // general workspace string // work out in temp the left most three characters and then compare this with // some known bad values path.Left(&temp,4); // temp = left most 4 characters of path if ( temp.IsIdentical(TEXT(SEPARATOR_SYM) TEXT(SEPARATOR_SYM) TEXT(".") TEXT(SEPARATOR_SYM))) // NT device name starts with this return TRUE; // if start this then no more checks required path.Left(&temp,3); // temp = left most 3 characters of path temp.toUpper(); // Now convert to upper case if ( (temp.IsIdentical(TEXT("LPT"))) || // basic DOS print device (temp.IsIdentical(TEXT("COM"))) || // basic DOS communication port (temp.IsIdentical(TEXT("NUL"))) || // basic DOS null device (temp.IsIdentical(TEXT("AUX")))) // basic DOS auxiliary port { // Check that the length of the name is correct i.e. 3, 4 or 5 long const TCHAR *dn; // device name pointer dn = path; // set to point to the current path switch (path.Length()) { case 3: // correct length and passed the test above so its a device name // drop through to after case and return True break; case 4: // check for number or a colon on the end // position is from 0.. and so want character number 3 dn += 3; // point to third character in name if ( ( !String::IsNumeric(*dn) ) && ( *dn != COLON ) ) return FALSE; // not colon or number // drop through to after case and return True break; case 5: // check for number and colon on the end // position is from 0.. and so want character number 3 dn += 3; // point to third character in name // first check that the second to last character is a number if ( !String::IsNumeric(*dn) ) return FALSE; // not a number so return False // now check that the last character is a colon dn += 1; // move to last character if ( *dn != COLON ) return FALSE; // not a colon so return False // drop through to after case and return True break; default: // In all other cases can return False as wrong length return FALSE; break; } // end switch return TRUE; // passed above tests so return True } else return FALSE; // failed in three letter comparisons so not a recognised device }

BOOL IsReservedChar (  const TCHAR **  fn  )

Checks if character passed in is a special character allowed in file names. No longer used. Scope: Private Checks if character passed in is a reserved character allowed in file names. Does not check for terminators which are allowed by the callers such as . and backslash. These characters are considered illegal when converting long to short filenames and so it would seem sensible to limit their use. Scope: Private. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 29/08/94 Parameters: A  pointer to the pointer to the path string [INPUTS] None  [OUTPUTS] Returns: True if the character is a reserved character not allowed in filenames and False otherwise See also: PathName(); Returns: Errors: None Definition at line 1528 of file pathname.cpp. { const TCHAR SLASH = '/'; const TCHAR OPENSQUARE = '['; const TCHAR CLOSESQUARE = ']'; const TCHAR QUOTES = '"'; const TCHAR COLON_TCHAR = ':'; const TCHAR SEMICOLON = ';'; const TCHAR COMMA = ','; const TCHAR EQUALS = '='; if ((**fn != SLASH) && (**fn != OPENSQUARE) && (**fn != CLOSESQUARE) && (**fn != QUOTES) && (**fn != COLON_TCHAR) && (**fn != SEMICOLON) && (**fn != COMMA) && (**fn != EQUALS)) return FALSE; else return TRUE; }

---