File size: 2,621 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Diagnostics;
using System.Globalization;
namespace System.Management.Automation.Help
{
/// <summary>
/// Updatable help system internal representation of the PSModuleInfo class.
/// </summary>
internal class UpdatableHelpModuleInfo
{
#if UNIX
internal static readonly string HelpContentZipName = "HelpContent.zip";
#else
internal static readonly string HelpContentZipName = "HelpContent.cab";
#endif
internal static readonly string HelpIntoXmlName = "HelpInfo.xml";
/// <summary>
/// Class constructor.
/// </summary>
/// <param name="name">Module name.</param>
/// <param name="guid">Module GUID.</param>
/// <param name="path">Module path.</param>
/// <param name="uri">HelpInfo URI.</param>
internal UpdatableHelpModuleInfo(string name, Guid guid, string path, string uri)
{
Debug.Assert(!string.IsNullOrEmpty(name));
Debug.Assert(!string.IsNullOrEmpty(path));
Debug.Assert(!string.IsNullOrEmpty(uri));
ModuleName = name;
_moduleGuid = guid;
ModuleBase = path;
HelpInfoUri = uri;
}
/// <summary>
/// Module name.
/// </summary>
internal string ModuleName { get; }
/// <summary>
/// Module GUID.
/// </summary>
internal Guid ModuleGuid
{
get
{
return _moduleGuid;
}
}
private readonly Guid _moduleGuid;
/// <summary>
/// Module path.
/// </summary>
internal string ModuleBase { get; }
/// <summary>
/// HelpInfo URI.
/// </summary>
internal string HelpInfoUri { get; }
/// <summary>
/// Gets the combined HelpContent.zip name.
/// </summary>
/// <param name="culture">Current culture.</param>
/// <returns>HelpContent name.</returns>
internal string GetHelpContentName(CultureInfo culture)
{
Debug.Assert(culture != null);
return ModuleName + "_" + _moduleGuid.ToString() + "_" + culture.Name + "_" + HelpContentZipName;
}
/// <summary>
/// Gets the combined HelpInfo.xml name.
/// </summary>
/// <returns>HelpInfo name.</returns>
internal string GetHelpInfoName()
{
return ModuleName + "_" + _moduleGuid.ToString() + "_" + HelpIntoXmlName;
}
}
}
|