Code:
/ Dotnetfx_Vista_SP2 / Dotnetfx_Vista_SP2 / 8.0.50727.4016 / WIN_WINDOWS / lh_tools_devdiv_wpf / Windows / wcp / Speech / Src / Internal / ObjectToken / ObjectToken.cs / 1 / ObjectToken.cs
//----------------------------------------------------------------------------
//
//
// Copyright (C) Microsoft Corporation. All rights reserved.
//
//
//
// Description:
// Object Token
//
// History:
// 7/1/2004 jeanfp
//---------------------------------------------------------------------------
using Microsoft.Win32;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Diagnostics;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using RegistryEntry = System.Collections.Generic.KeyValuePair;
namespace System.Speech.Internal.ObjectTokens
{
///
/// Summary description for ObjectToken.
///
#if VSCOMPILE
[DebuggerDisplay ("{Name}")]
#endif
internal class ObjectToken : RegistryDataKey, ISpObjectToken
#if SPEECHSERVER
,ISpObjectTokenMss
#endif
{
//*******************************************************************
//
// Constructors
//
//*******************************************************************
#region Constructors
protected ObjectToken (string keyId, RegistryKey hkey)
: base (keyId, hkey)
{
}
internal static RegistryKey CreateKey (string sCategoryId, string sTokenId, bool fCreateIfNotExist, out string id)
{
id = null;
RegistryKey hkey = null;
if (ParseRegistryString (sCategoryId, sTokenId))
{
hkey = RegistryDataKey.CreateKey (sTokenId, fCreateIfNotExist, out id);
}
return hkey;
}
internal static ObjectToken Create (string sCategoryId, string sTokenId, bool fCreateIfNotExist)
{
string id;
RegistryKey hkey = CreateKey (sTokenId, fCreateIfNotExist, out id);
if (hkey != null)
{
return new ObjectToken (id, hkey);
}
return null;
}
#endregion
//********************************************************************
//
// Public Methods
//
//*******************************************************************
#region public Methods
///
/// Tests whether two AutomationIdentifier objects are equivalent
///
public override bool Equals (object obj)
{
ObjectToken token = obj as ObjectToken;
return token != null && string.Compare (Id, token.Id, StringComparison.OrdinalIgnoreCase) == 0;
}
///
/// Overrides Object.GetHashCode()
///
public override int GetHashCode ()
{
return Id.GetHashCode ();
}
#endregion
//********************************************************************
//
// Internal Properties
//
//********************************************************************
#region Internal Properties
internal RegistryDataKey Attributes
{
get
{
return _attributes != null ? _attributes : (_attributes = OpenKey ("Attributes"));
}
}
///
/// Returns the Name for the voice
/// Look first in the Name attribute, if not available then get the default string
///
///
/// Returns the Culture defined in the Language field for a token
///
///
/// Returns the Culture defined in the Language field for a token
///
///
/// Check if the token supports the attributes list given in. The
/// attributes list has the same format as the required attributes given to
/// SpEnumTokens.
///
///
///
///
///
///
///
///
/// Remove the specified storage file name and optionally delete the file
///
///
///
///
internal void RemoveStorageFileName (Guid clsidCaller, string sValueName, bool fDeleteFile)
{
// SPDBG_FUNC("CSpObjectToken::RemoveStorageFileName");
ObjectToken cpDataKey = OpenFilesKey (clsidCaller, false);
if (fDeleteFile)
{
DeleteFileFromKey (cpDataKey, sValueName);
}
cpDataKey.DeleteValue (sValueName);
}
///
/// Get a filename which can be manipulated by this token. Storage files will
/// be deleted on a Remove call.
/// clsidCaller - a key will be made in registry below the token with this name and files key beneath that.
/// sValueName - Value name which will be made in registry to store the file path string.
/// sFileSpecifier - either null or a path/filename for storage file:
/// - if this starts with 'X:\' or '\\' then is assumed to be a full path.
/// - otherwise is assumed to be relative to special folders given in the nFolder parameter.
/// - if ends with a '\', or is null a unique filename will be created.
/// - if the name contains a %d the %d is replaced by a number to give a unique filename.
/// - intermediate directories are created.
/// - if a relative file is being used the value stored in the registry includes
/// the nFolder value as %nFolder% before the rest of the path. This allows
/// roaming to work properly if you pick an nFolder value representing a raoming folder
/// nFolder - equivalent to the value given to SHGetFolderPath in the Shell API.
/// ppszFilePath - CoTaskMemAlloc'd returned file path.
///
///
///
///
///
///
///
internal string GetStorageFileName (Guid clsidCaller, string sValueName, string sFileSpecifier, Environment.SpecialFolder nFolder, bool fCreate)
{
string ppszFilePath = null;
// SPDBG_FUNC("CSpObjectToken::GetStorageFileName");
// See if there is already a Files key in the registry for this token
ObjectToken cpFilesKey = OpenFilesKey (clsidCaller, (int) nFolder != 0);
string dstrFilePath; // Path to the file which we return to user.
string dstrRegPath; // Path to the string which will be stored in the registry.
// See if the key we are looking for is present
cpFilesKey.TryGetString (sValueName, out dstrRegPath);
#if _WIN32_WCE
if (hr == SPERR_NOT_FOUND && nFolder)
#else
if (fCreate && dstrRegPath != null)
#endif //_WIN32_WCE
{
// Didn't find the key and want to create
// Calculate the new file path and key value
FileSpecifierToRegPath (sFileSpecifier, nFolder, out dstrFilePath, out dstrRegPath);
// Set the key value
cpFilesKey.SetString (sValueName, dstrRegPath);
}
else
{
// Found existing entry so convert and return
RegPathToFilePath (dstrRegPath, out dstrFilePath);
}
ppszFilePath = dstrFilePath;
return ppszFilePath;
}
///
/// Determine if the specific type of UI is supported or not
///
///
///
/// Remove either a specified caller's section of the token, or the
/// entire token. We remove the entire token if pclsidCaller == null.
///
///
internal void Remove (Guid pclsidCaller)
{
// SPDBG_FUNC("CSpObjectToken::Remove");
// Remove all the filenames
RemoveAllStorageFileNames (pclsidCaller);
// Now go ahead and delete the registry entry which is either
// the token itself (if pclsidCaller == null) or the clsid's
// sub key
if (pclsidCaller == Guid.Empty)
{
RegistryDataKey.DeleteRegistryPath (Id, null);
}
else
{
//
throw new NotImplementedException ();
// string szClsid; //[MAX_PATH];
// StringFromGUID2(pclsidCaller, szClsid, sp_countof(szClsid));
// RegistryDataKey.SpDeleteRegPath(_dstrTokenId, szClsid);
}
}
#endif
internal T CreateObjectFromToken (string name)
{
T instanceValue = default (T);
string clsid;
if (!TryGetString (name, out clsid))
{
throw new ArgumentException (SR.Get (SRID.TokenCannotCreateInstance));
}
try
{
// Application Class Id
Type type = Type.GetTypeFromCLSID (new Guid (clsid));
// Create the object instance
instanceValue = (T) Activator.CreateInstance (type);
// Initialize the instance
ISpObjectWithToken objectWithToken = instanceValue as ISpObjectWithToken;
if (objectWithToken != null)
{
//IntPtr ite = Marshal.GetComInterfaceForObject (this, typeof (ISpObjectToken2));
int hresult = objectWithToken.SetObjectToken ((ISpObjectToken) this);
if (hresult < 0)
{
throw new ArgumentException (SR.Get (SRID.TokenCannotCreateInstance));
}
}
#if SPEECHSERVER
else
{
// For MSS - we should try the new MSS interface (with new GUID).
ISpObjectWithTokenMss objectWithTokenMss = instanceValue as ISpObjectWithTokenMss;
if (objectWithTokenMss != null)
{
objectWithTokenMss.SetObjectToken((ISpObjectTokenMss)this);
}
}
#endif
}
catch (Exception e)
{
//wow I am not really sure we want to do this here....
if (e is MissingMethodException || e is TypeLoadException || e is FileLoadException || e is FileNotFoundException || e is MethodAccessException || e is MemberAccessException || e is TargetInvocationException || e is InvalidComObjectException || e is NotSupportedException || e is FormatException)
{
throw new ArgumentException (SR.Get (SRID.TokenCannotCreateInstance));
}
throw;
}
return instanceValue;
}
#endregion
//*******************************************************************
//
// Protected Methods
//
//*******************************************************************
#region Protected Methods
protected override void Dispose (bool disposing)
{
try
{
if (disposing && _attributes != null)
{
_attributes.Dispose ();
_attributes = null;
}
}
finally
{
base.Dispose (disposing);
}
}
#endregion
//*******************************************************************
//
// Private Methods
//
//********************************************************************
#region private Methods
#if false
///
/// Given a path and file specifier, creates a new filename.
/// Just the filename is returned, not the path.
///
///
///
///
/// Creates all non-existent directories in sPath. Assumes all
/// directories prior to createFrom string offset already exist.
///
///
///
private static void CreatePath (string sPath, int createFrom)
{
//if \\ skip \\ find next '\'
if (createFrom == 0 && sPath.Length >= 2 && sPath.IndexOf ("\\\\") == 0)
{
while (sPath [createFrom] == '\\')
{
createFrom++;
}
int iPos = sPath.IndexOf ('\\', createFrom);
if (iPos >= 0)
{
throw new ArgumentException (SR.Get (SRID.NoBackSlash, "createFrom"), "createFrom");
}
createFrom = iPos;
}
// Skip any '\' (also at start to cope with \\machine network paths
while (sPath [createFrom] == '\\')
{
createFrom++;
}
for (int iStart = createFrom; iStart < sPath.Length; iStart++)
{
// Scan thought path. Each time reach a '\', copy section and try and create directory
if (sPath [iStart] == '\\')
{
// Copy last section and trailing slash
string dstrIncrementalPath = sPath.Substring (0, iStart);
if (!Directory.Exists (dstrIncrementalPath))
{
Directory.CreateDirectory (dstrIncrementalPath);
}
}
}
if (!Directory.Exists (sPath))
{
Directory.CreateDirectory (sPath);
}
}
///
/// Given the file specifier string and nFolder value, convert to a reg key and file path.
///
///
///
///
///
private static void FileSpecifierToRegPath (string sFileSpecifier, Environment.SpecialFolder nFolder, out string dstrFilePath, out string dstrRegPath)
{
// Make sure return strings are empty
dstrFilePath = null;
dstrRegPath = null;
// Is it a "X:\" path or a "\\" path
if (sFileSpecifier != null && sFileSpecifier.Length >= 3 && (sFileSpecifier.IndexOf (":\\", 1) == 1 || sFileSpecifier.IndexOf ("\\\\") == 0))
{
// Find last '\' that separates path from base file
int iBaseFile = sFileSpecifier.LastIndexOf ('\\');
iBaseFile++;
// dstrFilePath holds the path with trailing '\'
dstrFilePath = sFileSpecifier.Substring (0, iBaseFile);
CreatePath (dstrFilePath, 0);
// Calculate the new filename
string sFile = GenerateFileName (dstrFilePath, sFileSpecifier.Substring (iBaseFile + 1));
// Add fileName to path and copy to reg key
dstrFilePath = dstrFilePath + @"\" + sFile;
dstrRegPath = dstrFilePath;
}
// It's a relative path
else
{
#if _WIN32_WCE
string szPath = "\\Windows";
#else
string szPath = Environment.GetFolderPath (nFolder);
#endif
int ulCreateDirsFrom = szPath.Length;
// dstrFilePath holds the special folder path no trailing '\'
dstrFilePath = szPath + sFileStoragePath;
// Make the %...% folder identifier
#if !_WIN32_WCE
string sFolder = string.Format (CultureInfo.InvariantCulture, "%{0}%", (int) nFolder);
#else
string sFolder = "\\Windows";
#endif
// Add the %...% and path into reg data.
dstrRegPath = sFolder + sFileStoragePath;
// both dstrRegPath and dstrFilePath have trailing '\'
// Now add any fileNameSpecifier directories
int iBaseFile;
if (sFileSpecifier == null || sFileSpecifier.Length == 0)
{
iBaseFile = 0;
}
else
{
iBaseFile = sFileSpecifier.LastIndexOf ('\\');
if (iBaseFile > 0)
{
// Specifier contains '\'
iBaseFile++; // part after last '\' becomes base file
int iStart = 0;
if (sFileSpecifier [0] == '\\')
{
iStart++; // Skip initial '\'
}
// Add file specifier path to file and key
dstrFilePath = dstrRegPath = sFileSpecifier.Substring (iStart, iBaseFile - iStart + 1);
}
}
// Create any new directories
CreatePath (dstrFilePath, ulCreateDirsFrom);
// Generate the actual file name
string sFile = GenerateFileName (dstrFilePath, sFileSpecifier.Substring (iBaseFile + 1, sFileSpecifier.Length - iBaseFile + 1));
// Add file name to path and reg key
dstrRegPath += sFile;
dstrFilePath += sFile;
}
}
///
/// Given a file storage value from the registry, convert to a file path.
/// This will extract the %...% value and finds the local special folder path.
///
///
///
private static void RegPathToFilePath (string sRegPath, out string dstrFilePath)
{
// Is this a reference to a special folder
if (sRegPath [0] == '%')
{
// Find the second % symbol
int iPosPercent = sRegPath.LastIndexOf ('%');
// Convert the string between the %s to a number
int nFolder = 0;
if (!int.TryParse (sRegPath.Substring (iPosPercent, iPosPercent - 1), out nFolder))
{
throw new ArgumentException (SR.Get (SRID.InvalidRegistryEntry, "sRegPath"), "sRegPath");
}
// Point to start of real path '\'
if (sRegPath [++iPosPercent] != '\\')
{
throw new ArgumentException (SR.Get (SRID.InvalidRegistryEntry, "sRegPath"), "sRegPath");
}
#if _WIN32_WCE
string szPath = @"\Windows";
#else
string szPath = Environment.GetFolderPath ((Environment.SpecialFolder) nFolder);
#endif
// filePath now has the special folder path (with no trailing '\')
dstrFilePath = szPath + sRegPath.Substring (iPosPercent, sRegPath.Length - iPosPercent);
}
else
{
// Not a special folder so just copy
dstrFilePath = sRegPath;
}
}
#if false
/****************************************************************************
* CSpObjectToken__DisplayUI *
*---------------------------*
* Description:
* Display the specified type of UI
*
* Return:
* S_OK on success
* FAILED(hr) otherwise
******************************************************************** robch */
private void DisplayUI(
HWND hwndParent,
string sTitle,
string sTypeOfUI,
object pvExtraData,
uint cbExtraData,
object punkObject)
{
// SPDBG_FUNC("CSpObjectToken::DisplayUI");
HRESULT hr;
CLSID clsidObject;
if (m_fKeyDeleted)
{
// TODO
throw new ObjectTokenException(SR.Get (SRID.TokenDeleted));
}
else if (!IsWindow(hwndParent) ||
SP_IS_BAD_OPTIONAL_STRING_PTR(sTitle) ||
SP_IS_BAD_STRING_PTR(sTypeOfUI) ||
(pvExtraData != null && SPIsBadReadPtr(pvExtraData, cbExtraData)) ||
(punkObject != null && SP_IS_BAD_INTERFACE_PTR(punkObject)))
{
E_INVALIDARG;
}
else if (m_cpTokenDelegate != null)
{
// NTRAID#SPEECH-7392-2000/08/31-robch: Maybe we should first delegate, and if that doesn't work,
// try this token's category ui...
m_cpTokenDelegate.DisplayUI(
hwndParent,
sTitle,
sTypeOfUI,
pvExtraData,
cbExtraData,
punkObject);
}
else
{
GetUIObjectClsid(sTypeOfUI, &clsidObject);
ISpTokenUI cpTokenUI = cpTokenUI.CoCreateInstance(clsidObject);
cpTokenUI.DisplayUI(
hwndParent,
sTitle,
sTypeOfUI,
pvExtraData,
cbExtraData,
this,
punkObject);
}
SPDBG_REPORT_ON_FAIL(hr);
return hr;
}
#endif
///
/// Open the "Files" subkey of a specified data key's caller's sub key
///
///
///
///
/// Delete either a specific file (specified by sValueName) or all files
/// (when sValueName == null) from the specified data key
///
///
///
private void DeleteFileFromKey (ObjectToken pDataKey, string sValueName)
{
// SPDBG_FUNC("CSpObjectToken::DeleteFileFromKey");
// If the value name wasn't specified, we'll delete all the value's files
if (sValueName == null)
{
// Loop thru the values
foreach (RegistryEntry regEntry in (IEnumerable) pDataKey)
{
try
{
// Delete the file
DeleteFileFromKey (pDataKey, (string) regEntry.Value);
}
catch (IOException)
{
// ignore the File IO exception
}
}
}
else
{
// Get the filename
string sFile;
string dstrRegPath = pDataKey.GetString (sValueName);
// Convert the path stored in the registry to a real file path
RegPathToFilePath (dstrRegPath, out sFile);
// And delete the file
// Ignore errors from DeleteFile, we can't let this stop us
try
{
File.Delete (sFile);
}
catch (IOException)
{
}
}
}
///
/// Remove all filenames for a specified caller, or for all callers
/// if pclsidCaller is null.
///
///
private void RemoveAllStorageFileNames (Guid pclsidCaller)
{
// SPDBG_FUNC("CSpObjectToken::RemoveAllStorageFileNames");
// If the clsid wasn't specified, we'll delete all files from all
// keys that are clsids
if (pclsidCaller == Guid.Empty)
{
// Loop thru all the keys
for (int i = 0; ; i++)
{
// Get the next sub key
//TODO
string dstrSubKey = null; //((ObjectToken) this).EnumKeys (i);
if (dstrSubKey != null)
{
break;
}
// If this key looks like a clsid, and it is, recursively call
// this function to delete the specific clsid's files
Guid clsid = new Guid (dstrSubKey);
RemoveAllStorageFileNames (clsid);
}
}
else
{
// Open the files data key, and delete all the files
ObjectToken cpFilesKey = OpenFilesKey (pclsidCaller, false);
{
try
{
DeleteFileFromKey (cpFilesKey, null);
}
catch (SystemException)
{
// If we failed to delete this file then that should not stop us from deleting the other files.
}
}
}
}
#endif
///
/// Description:
/// Parse a token id into it's parts. For example:
///
/// sCategoryId = HKEY...\Recognizers
/// sTokenId = HKEY...\Recognizers\Tokens\MSASR English
///
/// *ppszCategoryId = HKEY...\Recognizers
/// *ppszTokenId = HKEY...\Recognizers\Tokens\MSASR English
/// *ppszTokenIdForEnum = null
/// *ppszTokenEnumExtra = null
///
/// or
///
/// sCategoryId = HKEY...\AudioIn
/// sTokenId = HKEY...\AudioIn\TokenEnums\DSound
///
/// *ppszCategoryId = HKEY...\AudioIn
/// *ppszTokenId = HKEY...\AudioIn\TokenEnums\DSound
/// *ppszTokenIdForEnum = HKEY...\AudioIn\TokenEnums\DSound
/// *ppszTokenEnumExtra = null
///
/// or
///
/// sCategoryId = HKEY...\AudioIn
/// sTokenId = HKEY...\AudioIn\TokenEnums\DSound\CrystalWave
///
/// *ppszCategoryId = HKEY...\AudioIn
/// *ppszTokenId = HKEY...\AudioIn\TokenEnums\DSound\CrystalWave
/// *ppszTokenIdForEnum = HKEY...\AudioIn\TokenEnums\DSound
/// *ppszTokenEnumExtra = CrystalWave
///
/// sCategoryId can be null. If it is, we'll calculate the category id
/// by finding the first occurrence of either "Tokens" or "TokenEnums"
/// The category id will immediately proceed that.
///
///
///
private static bool ParseRegistryString (string sCategoryId, string sTokenId)
{
// If the caller supplied a category, we already know how big it is
int cchCategoryId = 0;
if (!string.IsNullOrEmpty (sCategoryId))
{
cchCategoryId = sCategoryId.Length;
if (sTokenId.Length < sCategoryId.Length || string.Compare (sTokenId.Substring (0, cchCategoryId), sCategoryId, StringComparison.OrdinalIgnoreCase) != 0)
{
// The tokenid wasn't prefaced with the category id, a must
return false;
}
}
string sSlashTokensSlash = "Tokens";
int iFirst = cchCategoryId;
int cchTokenId = sTokenId.Length;
while (iFirst < sTokenId.Length)
{
int iSecond = sTokenId.IndexOf ('\\', iFirst);
if (iSecond < 0)
{
iSecond = cchTokenId;
}
// name between '/' '/'
string sEntry = sTokenId.Substring (iFirst, iSecond - iFirst);
if (string.Compare (sEntry, sSlashTokensSlash, StringComparison.OrdinalIgnoreCase) == 0)
{
cchCategoryId = iFirst;
break;
}
else if (cchCategoryId > 0)
{
break;
}
else
{
iFirst = iSecond + 1;
}
}
if (cchCategoryId == 0)
{
int iPosCategory = sTokenId.LastIndexOf ('\\');
if (iPosCategory < 0)
{
return false;
}
else
{
cchCategoryId = iPosCategory;
}
}
if (cchCategoryId <= 0)
{
return false;
}
return true;
}
#if VSCOMPILE && false
///
/// Get the UI object's clsid from the registry. First check under the
/// token's root, then under the category
///
///
///
// Copyright (C) Microsoft Corporation. All rights reserved.
//
//
//
// Description:
// Object Token
//
// History:
// 7/1/2004 jeanfp
//---------------------------------------------------------------------------
using Microsoft.Win32;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Diagnostics;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using RegistryEntry = System.Collections.Generic.KeyValuePair;
namespace System.Speech.Internal.ObjectTokens
{
///
/// Summary description for ObjectToken.
///
#if VSCOMPILE
[DebuggerDisplay ("{Name}")]
#endif
internal class ObjectToken : RegistryDataKey, ISpObjectToken
#if SPEECHSERVER
,ISpObjectTokenMss
#endif
{
//*******************************************************************
//
// Constructors
//
//*******************************************************************
#region Constructors
protected ObjectToken (string keyId, RegistryKey hkey)
: base (keyId, hkey)
{
}
internal static RegistryKey CreateKey (string sCategoryId, string sTokenId, bool fCreateIfNotExist, out string id)
{
id = null;
RegistryKey hkey = null;
if (ParseRegistryString (sCategoryId, sTokenId))
{
hkey = RegistryDataKey.CreateKey (sTokenId, fCreateIfNotExist, out id);
}
return hkey;
}
internal static ObjectToken Create (string sCategoryId, string sTokenId, bool fCreateIfNotExist)
{
string id;
RegistryKey hkey = CreateKey (sTokenId, fCreateIfNotExist, out id);
if (hkey != null)
{
return new ObjectToken (id, hkey);
}
return null;
}
#endregion
//********************************************************************
//
// Public Methods
//
//*******************************************************************
#region public Methods
///
/// Tests whether two AutomationIdentifier objects are equivalent
///
public override bool Equals (object obj)
{
ObjectToken token = obj as ObjectToken;
return token != null && string.Compare (Id, token.Id, StringComparison.OrdinalIgnoreCase) == 0;
}
///
/// Overrides Object.GetHashCode()
///
public override int GetHashCode ()
{
return Id.GetHashCode ();
}
#endregion
//********************************************************************
//
// Internal Properties
//
//********************************************************************
#region Internal Properties
internal RegistryDataKey Attributes
{
get
{
return _attributes != null ? _attributes : (_attributes = OpenKey ("Attributes"));
}
}
///
/// Returns the Name for the voice
/// Look first in the Name attribute, if not available then get the default string
///
///
/// Returns the Culture defined in the Language field for a token
///
///
/// Returns the Culture defined in the Language field for a token
///
///
/// Check if the token supports the attributes list given in. The
/// attributes list has the same format as the required attributes given to
/// SpEnumTokens.
///
///
///
///
///
///
///
///
/// Remove the specified storage file name and optionally delete the file
///
///
///
///
internal void RemoveStorageFileName (Guid clsidCaller, string sValueName, bool fDeleteFile)
{
// SPDBG_FUNC("CSpObjectToken::RemoveStorageFileName");
ObjectToken cpDataKey = OpenFilesKey (clsidCaller, false);
if (fDeleteFile)
{
DeleteFileFromKey (cpDataKey, sValueName);
}
cpDataKey.DeleteValue (sValueName);
}
///
/// Get a filename which can be manipulated by this token. Storage files will
/// be deleted on a Remove call.
/// clsidCaller - a key will be made in registry below the token with this name and files key beneath that.
/// sValueName - Value name which will be made in registry to store the file path string.
/// sFileSpecifier - either null or a path/filename for storage file:
/// - if this starts with 'X:\' or '\\' then is assumed to be a full path.
/// - otherwise is assumed to be relative to special folders given in the nFolder parameter.
/// - if ends with a '\', or is null a unique filename will be created.
/// - if the name contains a %d the %d is replaced by a number to give a unique filename.
/// - intermediate directories are created.
/// - if a relative file is being used the value stored in the registry includes
/// the nFolder value as %nFolder% before the rest of the path. This allows
/// roaming to work properly if you pick an nFolder value representing a raoming folder
/// nFolder - equivalent to the value given to SHGetFolderPath in the Shell API.
/// ppszFilePath - CoTaskMemAlloc'd returned file path.
///
///
///
///
///
///
///
internal string GetStorageFileName (Guid clsidCaller, string sValueName, string sFileSpecifier, Environment.SpecialFolder nFolder, bool fCreate)
{
string ppszFilePath = null;
// SPDBG_FUNC("CSpObjectToken::GetStorageFileName");
// See if there is already a Files key in the registry for this token
ObjectToken cpFilesKey = OpenFilesKey (clsidCaller, (int) nFolder != 0);
string dstrFilePath; // Path to the file which we return to user.
string dstrRegPath; // Path to the string which will be stored in the registry.
// See if the key we are looking for is present
cpFilesKey.TryGetString (sValueName, out dstrRegPath);
#if _WIN32_WCE
if (hr == SPERR_NOT_FOUND && nFolder)
#else
if (fCreate && dstrRegPath != null)
#endif //_WIN32_WCE
{
// Didn't find the key and want to create
// Calculate the new file path and key value
FileSpecifierToRegPath (sFileSpecifier, nFolder, out dstrFilePath, out dstrRegPath);
// Set the key value
cpFilesKey.SetString (sValueName, dstrRegPath);
}
else
{
// Found existing entry so convert and return
RegPathToFilePath (dstrRegPath, out dstrFilePath);
}
ppszFilePath = dstrFilePath;
return ppszFilePath;
}
///
/// Determine if the specific type of UI is supported or not
///
///
///
/// Remove either a specified caller's section of the token, or the
/// entire token. We remove the entire token if pclsidCaller == null.
///
///
internal void Remove (Guid pclsidCaller)
{
// SPDBG_FUNC("CSpObjectToken::Remove");
// Remove all the filenames
RemoveAllStorageFileNames (pclsidCaller);
// Now go ahead and delete the registry entry which is either
// the token itself (if pclsidCaller == null) or the clsid's
// sub key
if (pclsidCaller == Guid.Empty)
{
RegistryDataKey.DeleteRegistryPath (Id, null);
}
else
{
//
throw new NotImplementedException ();
// string szClsid; //[MAX_PATH];
// StringFromGUID2(pclsidCaller, szClsid, sp_countof(szClsid));
// RegistryDataKey.SpDeleteRegPath(_dstrTokenId, szClsid);
}
}
#endif
internal T CreateObjectFromToken (string name)
{
T instanceValue = default (T);
string clsid;
if (!TryGetString (name, out clsid))
{
throw new ArgumentException (SR.Get (SRID.TokenCannotCreateInstance));
}
try
{
// Application Class Id
Type type = Type.GetTypeFromCLSID (new Guid (clsid));
// Create the object instance
instanceValue = (T) Activator.CreateInstance (type);
// Initialize the instance
ISpObjectWithToken objectWithToken = instanceValue as ISpObjectWithToken;
if (objectWithToken != null)
{
//IntPtr ite = Marshal.GetComInterfaceForObject (this, typeof (ISpObjectToken2));
int hresult = objectWithToken.SetObjectToken ((ISpObjectToken) this);
if (hresult < 0)
{
throw new ArgumentException (SR.Get (SRID.TokenCannotCreateInstance));
}
}
#if SPEECHSERVER
else
{
// For MSS - we should try the new MSS interface (with new GUID).
ISpObjectWithTokenMss objectWithTokenMss = instanceValue as ISpObjectWithTokenMss;
if (objectWithTokenMss != null)
{
objectWithTokenMss.SetObjectToken((ISpObjectTokenMss)this);
}
}
#endif
}
catch (Exception e)
{
//wow I am not really sure we want to do this here....
if (e is MissingMethodException || e is TypeLoadException || e is FileLoadException || e is FileNotFoundException || e is MethodAccessException || e is MemberAccessException || e is TargetInvocationException || e is InvalidComObjectException || e is NotSupportedException || e is FormatException)
{
throw new ArgumentException (SR.Get (SRID.TokenCannotCreateInstance));
}
throw;
}
return instanceValue;
}
#endregion
//*******************************************************************
//
// Protected Methods
//
//*******************************************************************
#region Protected Methods
protected override void Dispose (bool disposing)
{
try
{
if (disposing && _attributes != null)
{
_attributes.Dispose ();
_attributes = null;
}
}
finally
{
base.Dispose (disposing);
}
}
#endregion
//*******************************************************************
//
// Private Methods
//
//********************************************************************
#region private Methods
#if false
///
/// Given a path and file specifier, creates a new filename.
/// Just the filename is returned, not the path.
///
///
///
///
/// Creates all non-existent directories in sPath. Assumes all
/// directories prior to createFrom string offset already exist.
///
///
///
private static void CreatePath (string sPath, int createFrom)
{
//if \\ skip \\ find next '\'
if (createFrom == 0 && sPath.Length >= 2 && sPath.IndexOf ("\\\\") == 0)
{
while (sPath [createFrom] == '\\')
{
createFrom++;
}
int iPos = sPath.IndexOf ('\\', createFrom);
if (iPos >= 0)
{
throw new ArgumentException (SR.Get (SRID.NoBackSlash, "createFrom"), "createFrom");
}
createFrom = iPos;
}
// Skip any '\' (also at start to cope with \\machine network paths
while (sPath [createFrom] == '\\')
{
createFrom++;
}
for (int iStart = createFrom; iStart < sPath.Length; iStart++)
{
// Scan thought path. Each time reach a '\', copy section and try and create directory
if (sPath [iStart] == '\\')
{
// Copy last section and trailing slash
string dstrIncrementalPath = sPath.Substring (0, iStart);
if (!Directory.Exists (dstrIncrementalPath))
{
Directory.CreateDirectory (dstrIncrementalPath);
}
}
}
if (!Directory.Exists (sPath))
{
Directory.CreateDirectory (sPath);
}
}
///
/// Given the file specifier string and nFolder value, convert to a reg key and file path.
///
///
///
///
///
private static void FileSpecifierToRegPath (string sFileSpecifier, Environment.SpecialFolder nFolder, out string dstrFilePath, out string dstrRegPath)
{
// Make sure return strings are empty
dstrFilePath = null;
dstrRegPath = null;
// Is it a "X:\" path or a "\\" path
if (sFileSpecifier != null && sFileSpecifier.Length >= 3 && (sFileSpecifier.IndexOf (":\\", 1) == 1 || sFileSpecifier.IndexOf ("\\\\") == 0))
{
// Find last '\' that separates path from base file
int iBaseFile = sFileSpecifier.LastIndexOf ('\\');
iBaseFile++;
// dstrFilePath holds the path with trailing '\'
dstrFilePath = sFileSpecifier.Substring (0, iBaseFile);
CreatePath (dstrFilePath, 0);
// Calculate the new filename
string sFile = GenerateFileName (dstrFilePath, sFileSpecifier.Substring (iBaseFile + 1));
// Add fileName to path and copy to reg key
dstrFilePath = dstrFilePath + @"\" + sFile;
dstrRegPath = dstrFilePath;
}
// It's a relative path
else
{
#if _WIN32_WCE
string szPath = "\\Windows";
#else
string szPath = Environment.GetFolderPath (nFolder);
#endif
int ulCreateDirsFrom = szPath.Length;
// dstrFilePath holds the special folder path no trailing '\'
dstrFilePath = szPath + sFileStoragePath;
// Make the %...% folder identifier
#if !_WIN32_WCE
string sFolder = string.Format (CultureInfo.InvariantCulture, "%{0}%", (int) nFolder);
#else
string sFolder = "\\Windows";
#endif
// Add the %...% and path into reg data.
dstrRegPath = sFolder + sFileStoragePath;
// both dstrRegPath and dstrFilePath have trailing '\'
// Now add any fileNameSpecifier directories
int iBaseFile;
if (sFileSpecifier == null || sFileSpecifier.Length == 0)
{
iBaseFile = 0;
}
else
{
iBaseFile = sFileSpecifier.LastIndexOf ('\\');
if (iBaseFile > 0)
{
// Specifier contains '\'
iBaseFile++; // part after last '\' becomes base file
int iStart = 0;
if (sFileSpecifier [0] == '\\')
{
iStart++; // Skip initial '\'
}
// Add file specifier path to file and key
dstrFilePath = dstrRegPath = sFileSpecifier.Substring (iStart, iBaseFile - iStart + 1);
}
}
// Create any new directories
CreatePath (dstrFilePath, ulCreateDirsFrom);
// Generate the actual file name
string sFile = GenerateFileName (dstrFilePath, sFileSpecifier.Substring (iBaseFile + 1, sFileSpecifier.Length - iBaseFile + 1));
// Add file name to path and reg key
dstrRegPath += sFile;
dstrFilePath += sFile;
}
}
///
/// Given a file storage value from the registry, convert to a file path.
/// This will extract the %...% value and finds the local special folder path.
///
///
///
private static void RegPathToFilePath (string sRegPath, out string dstrFilePath)
{
// Is this a reference to a special folder
if (sRegPath [0] == '%')
{
// Find the second % symbol
int iPosPercent = sRegPath.LastIndexOf ('%');
// Convert the string between the %s to a number
int nFolder = 0;
if (!int.TryParse (sRegPath.Substring (iPosPercent, iPosPercent - 1), out nFolder))
{
throw new ArgumentException (SR.Get (SRID.InvalidRegistryEntry, "sRegPath"), "sRegPath");
}
// Point to start of real path '\'
if (sRegPath [++iPosPercent] != '\\')
{
throw new ArgumentException (SR.Get (SRID.InvalidRegistryEntry, "sRegPath"), "sRegPath");
}
#if _WIN32_WCE
string szPath = @"\Windows";
#else
string szPath = Environment.GetFolderPath ((Environment.SpecialFolder) nFolder);
#endif
// filePath now has the special folder path (with no trailing '\')
dstrFilePath = szPath + sRegPath.Substring (iPosPercent, sRegPath.Length - iPosPercent);
}
else
{
// Not a special folder so just copy
dstrFilePath = sRegPath;
}
}
#if false
/****************************************************************************
* CSpObjectToken__DisplayUI *
*---------------------------*
* Description:
* Display the specified type of UI
*
* Return:
* S_OK on success
* FAILED(hr) otherwise
******************************************************************** robch */
private void DisplayUI(
HWND hwndParent,
string sTitle,
string sTypeOfUI,
object pvExtraData,
uint cbExtraData,
object punkObject)
{
// SPDBG_FUNC("CSpObjectToken::DisplayUI");
HRESULT hr;
CLSID clsidObject;
if (m_fKeyDeleted)
{
// TODO
throw new ObjectTokenException(SR.Get (SRID.TokenDeleted));
}
else if (!IsWindow(hwndParent) ||
SP_IS_BAD_OPTIONAL_STRING_PTR(sTitle) ||
SP_IS_BAD_STRING_PTR(sTypeOfUI) ||
(pvExtraData != null && SPIsBadReadPtr(pvExtraData, cbExtraData)) ||
(punkObject != null && SP_IS_BAD_INTERFACE_PTR(punkObject)))
{
E_INVALIDARG;
}
else if (m_cpTokenDelegate != null)
{
// NTRAID#SPEECH-7392-2000/08/31-robch: Maybe we should first delegate, and if that doesn't work,
// try this token's category ui...
m_cpTokenDelegate.DisplayUI(
hwndParent,
sTitle,
sTypeOfUI,
pvExtraData,
cbExtraData,
punkObject);
}
else
{
GetUIObjectClsid(sTypeOfUI, &clsidObject);
ISpTokenUI cpTokenUI = cpTokenUI.CoCreateInstance(clsidObject);
cpTokenUI.DisplayUI(
hwndParent,
sTitle,
sTypeOfUI,
pvExtraData,
cbExtraData,
this,
punkObject);
}
SPDBG_REPORT_ON_FAIL(hr);
return hr;
}
#endif
///
/// Open the "Files" subkey of a specified data key's caller's sub key
///
///
///
///
/// Delete either a specific file (specified by sValueName) or all files
/// (when sValueName == null) from the specified data key
///
///
///
private void DeleteFileFromKey (ObjectToken pDataKey, string sValueName)
{
// SPDBG_FUNC("CSpObjectToken::DeleteFileFromKey");
// If the value name wasn't specified, we'll delete all the value's files
if (sValueName == null)
{
// Loop thru the values
foreach (RegistryEntry regEntry in (IEnumerable) pDataKey)
{
try
{
// Delete the file
DeleteFileFromKey (pDataKey, (string) regEntry.Value);
}
catch (IOException)
{
// ignore the File IO exception
}
}
}
else
{
// Get the filename
string sFile;
string dstrRegPath = pDataKey.GetString (sValueName);
// Convert the path stored in the registry to a real file path
RegPathToFilePath (dstrRegPath, out sFile);
// And delete the file
// Ignore errors from DeleteFile, we can't let this stop us
try
{
File.Delete (sFile);
}
catch (IOException)
{
}
}
}
///
/// Remove all filenames for a specified caller, or for all callers
/// if pclsidCaller is null.
///
///
private void RemoveAllStorageFileNames (Guid pclsidCaller)
{
// SPDBG_FUNC("CSpObjectToken::RemoveAllStorageFileNames");
// If the clsid wasn't specified, we'll delete all files from all
// keys that are clsids
if (pclsidCaller == Guid.Empty)
{
// Loop thru all the keys
for (int i = 0; ; i++)
{
// Get the next sub key
//TODO
string dstrSubKey = null; //((ObjectToken) this).EnumKeys (i);
if (dstrSubKey != null)
{
break;
}
// If this key looks like a clsid, and it is, recursively call
// this function to delete the specific clsid's files
Guid clsid = new Guid (dstrSubKey);
RemoveAllStorageFileNames (clsid);
}
}
else
{
// Open the files data key, and delete all the files
ObjectToken cpFilesKey = OpenFilesKey (pclsidCaller, false);
{
try
{
DeleteFileFromKey (cpFilesKey, null);
}
catch (SystemException)
{
// If we failed to delete this file then that should not stop us from deleting the other files.
}
}
}
}
#endif
///
/// Description:
/// Parse a token id into it's parts. For example:
///
/// sCategoryId = HKEY...\Recognizers
/// sTokenId = HKEY...\Recognizers\Tokens\MSASR English
///
/// *ppszCategoryId = HKEY...\Recognizers
/// *ppszTokenId = HKEY...\Recognizers\Tokens\MSASR English
/// *ppszTokenIdForEnum = null
/// *ppszTokenEnumExtra = null
///
/// or
///
/// sCategoryId = HKEY...\AudioIn
/// sTokenId = HKEY...\AudioIn\TokenEnums\DSound
///
/// *ppszCategoryId = HKEY...\AudioIn
/// *ppszTokenId = HKEY...\AudioIn\TokenEnums\DSound
/// *ppszTokenIdForEnum = HKEY...\AudioIn\TokenEnums\DSound
/// *ppszTokenEnumExtra = null
///
/// or
///
/// sCategoryId = HKEY...\AudioIn
/// sTokenId = HKEY...\AudioIn\TokenEnums\DSound\CrystalWave
///
/// *ppszCategoryId = HKEY...\AudioIn
/// *ppszTokenId = HKEY...\AudioIn\TokenEnums\DSound\CrystalWave
/// *ppszTokenIdForEnum = HKEY...\AudioIn\TokenEnums\DSound
/// *ppszTokenEnumExtra = CrystalWave
///
/// sCategoryId can be null. If it is, we'll calculate the category id
/// by finding the first occurrence of either "Tokens" or "TokenEnums"
/// The category id will immediately proceed that.
///
///
///
private static bool ParseRegistryString (string sCategoryId, string sTokenId)
{
// If the caller supplied a category, we already know how big it is
int cchCategoryId = 0;
if (!string.IsNullOrEmpty (sCategoryId))
{
cchCategoryId = sCategoryId.Length;
if (sTokenId.Length < sCategoryId.Length || string.Compare (sTokenId.Substring (0, cchCategoryId), sCategoryId, StringComparison.OrdinalIgnoreCase) != 0)
{
// The tokenid wasn't prefaced with the category id, a must
return false;
}
}
string sSlashTokensSlash = "Tokens";
int iFirst = cchCategoryId;
int cchTokenId = sTokenId.Length;
while (iFirst < sTokenId.Length)
{
int iSecond = sTokenId.IndexOf ('\\', iFirst);
if (iSecond < 0)
{
iSecond = cchTokenId;
}
// name between '/' '/'
string sEntry = sTokenId.Substring (iFirst, iSecond - iFirst);
if (string.Compare (sEntry, sSlashTokensSlash, StringComparison.OrdinalIgnoreCase) == 0)
{
cchCategoryId = iFirst;
break;
}
else if (cchCategoryId > 0)
{
break;
}
else
{
iFirst = iSecond + 1;
}
}
if (cchCategoryId == 0)
{
int iPosCategory = sTokenId.LastIndexOf ('\\');
if (iPosCategory < 0)
{
return false;
}
else
{
cchCategoryId = iPosCategory;
}
}
if (cchCategoryId <= 0)
{
return false;
}
return true;
}
#if VSCOMPILE && false
///
/// Get the UI object's clsid from the registry. First check under the
/// token's root, then under the category
///
///
///
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- CompositeActivityTypeDescriptorProvider.cs
- CodeCatchClause.cs
- EmbeddedMailObject.cs
- DataObjectCopyingEventArgs.cs
- StructuredProperty.cs
- EntityDataSourceSelectedEventArgs.cs
- Compilation.cs
- PeerEndPoint.cs
- DesignerHierarchicalDataSourceView.cs
- QueryableDataSourceHelper.cs
- AnchorEditor.cs
- UnaryNode.cs
- ListItemCollection.cs
- DataGridHeaderBorder.cs
- CultureInfoConverter.cs
- AsyncPostBackTrigger.cs
- SerialErrors.cs
- TerminatorSinks.cs
- GeometryModel3D.cs
- Polyline.cs
- Token.cs
- CommandEventArgs.cs
- ReadOnlyPropertyMetadata.cs
- Point3DCollectionValueSerializer.cs
- MultiByteCodec.cs
- TransformValueSerializer.cs
- HwndKeyboardInputProvider.cs
- SQLStringStorage.cs
- XmlSignificantWhitespace.cs
- NamedPermissionSet.cs
- Help.cs
- InputElement.cs
- PathFigureCollection.cs
- ListControlConvertEventArgs.cs
- InternalConfigHost.cs
- ButtonAutomationPeer.cs
- ActivitySurrogate.cs
- BindingWorker.cs
- ConfigurationSchemaErrors.cs
- PathSegment.cs
- CodeVariableReferenceExpression.cs
- CharStorage.cs
- FlagsAttribute.cs
- WeakEventManager.cs
- SqlDataSourceParameterParser.cs
- CacheOutputQuery.cs
- ColumnResizeUndoUnit.cs
- CancellationScope.cs
- BitStack.cs
- DataRowView.cs
- TraceFilter.cs
- GenericAuthenticationEventArgs.cs
- ValidationRuleCollection.cs
- EmptyReadOnlyDictionaryInternal.cs
- WebPartEditVerb.cs
- OutputCacheProfile.cs
- TransactionContext.cs
- AssemblyName.cs
- ControlCachePolicy.cs
- Padding.cs
- GeometryDrawing.cs
- CqlWriter.cs
- Scene3D.cs
- PolicyVersionConverter.cs
- ExtensionsSection.cs
- TreeNodeCollection.cs
- XmlSchemaObjectTable.cs
- CorrelationManager.cs
- DataGridViewCellToolTipTextNeededEventArgs.cs
- PackageRelationshipCollection.cs
- Vertex.cs
- PlanCompilerUtil.cs
- ParserExtension.cs
- BamlBinaryReader.cs
- DefaultShape.cs
- XPathNodeList.cs
- ApplicationInterop.cs
- TextStore.cs
- HMACSHA1.cs
- SafeCloseHandleCritical.cs
- altserialization.cs
- ProxyGenerationError.cs
- CapabilitiesPattern.cs
- PolicyConversionContext.cs
- SessionStateModule.cs
- StatusStrip.cs
- HttpHandlersSection.cs
- GeometryCollection.cs
- RewritingProcessor.cs
- ModifierKeysValueSerializer.cs
- HtmlInputFile.cs
- SafeFileMappingHandle.cs
- ObjectStateEntryBaseUpdatableDataRecord.cs
- SoapEnumAttribute.cs
- RequestCachePolicyConverter.cs
- PropertyStore.cs
- TreeBuilderBamlTranslator.cs
- BamlResourceDeserializer.cs
- HttpHandlerAction.cs
- ReversePositionQuery.cs