• Avalanche.Core
Search Results for

    Show / Hide Table of Contents
    • Avalanche.Accessor
      • Introduction
      • IAccessor
        • IAccessor
        • IFieldAccessor
        • IListAccessor
        • IMapAccessor
        • IRecordAccessor
        • IOneOfAccessor
        • IAnyAccessor
      • Dto
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
      • Articles
        • Dependency Injection
        • AccessorMessages
    • Avalanche.Binding
      • Introduction
    • Avalanche.Configuration
      • Introduction
      • Configuration Binding
      • ConfigurationExtensions
      • MemoryConfiguration
      • PrintTree
      • Saving IOptions
      • Yaml
    • Avalanche.Converter
      • Introduction
      • EnumConverter
      • Func<,>
      • HexConverter
      • PrimitiveConverter
      • StringConverter
    • Avalanche.Core
      • License
    • Avalanche.DataType
      • Introduction
      • DataType
        • IDataType
        • IListType
        • IMapType
        • IRecordType
        • IFieldType
        • IOneOfType
        • IAnyType
        • IStringType
        • IValueType
        • IIntegerType
        • IEnumerationType
        • IFloatingPointType
      • Dto
        • Introduction
        • IList<T>
        • IDictionary<K,V>
        • FieldInfo
        • Enum
        • OneOfAttribute
        • StructLayoutAttribute
        • Class
        • DtoTarget(IDataType)
        • IntermediateTarget
      • Articles
        • DataTypeRequest
        • PrintTree
        • DataTypeMessages
    • Avalanche.Emit
      • Introduction
      • TypeBuilder
      • ConstructorBuilder
      • MethodBuilder
      • PropertyBuilder
      • FieldBuilder
      • Emit
      • Utilities
        • CustomAttributeUtilities
        • ToStringRequest
    • Avalanche.FileSystem
      • Introduction
      • Abstractions
        • IFileSystemBrowse
        • IFileSystemCreateDirectory
        • IFileSystemDelete
        • IFileSystemFileAttribute
        • IFileSystemMount
        • IFileSystemMove
        • IFileSystemObserve
        • IFileSystemOpenStream
        • IFileSystemOpenMemory
        • IEvent
        • IEntry
        • IOption
        • IToken
      • FileSystem
      • VirtualFileSystem
      • MemoryFileSystem
      • EmbeddedFileSystem
      • HttpFileSystem
      • Decoration
      • IFileProvider
      • Utilities
        • Dispose
        • FileDictionary
        • FileScanner
        • FilterEnumerable
        • OperationSession
        • PollingFilterWatchToken
        • VisitTree
      • Article
        • Examples
        • PrintTree
    • Avalanche.Identity
      • Introduction
      • Identity
      • IdentityParts
      • IdentityInterner
      • IdentityComparer
      • Print Tree
      • IdentityAccessors
        • Introduction
        • TypeName
    • Avalanche.Localization
      • Introduction
      • Localization
      • LocalizationFile
      • LocalizationFiles
      • LocalizationFileSystem
      • LocalizationFileFormat
      • LocalizationLine
      • LocalizationLines
      • TemplateFormat
      • CultureProvider
      • FallbackCultureProvider
      • ResourceManager
      • LocalizationError
      • Microsoft.Extensions
        • Introduction
        • DependencyInjection
        • FileProvider
        • Logging
        • ITextLocalizer
        • IFileLocalizer
        • Localization
      • Asp.Net
        • Introduction
        • Supplying localization
        • Inject to pages
        • Culture Assigned
        • Minimalistic Api
        • Diagnostics
      • Pluralization
        • Introduction
        • Multiple plural parameters
        • Custom PluralRules
        • Invariant Culture
        • Unit Prefix
        • IPluralRule
        • IPluralNumber
        • IPluralRules
        • CLDRs
        • Unicode.CLDR40
        • Unicode.CLDR41
        • Unicode.CLDR42
        • Unicode.CLDR43
      • Articles
        • Alphabet localization
        • Benchmarks
        • Caching
        • Class Library
        • Demo
        • Diagnostics
        • Embedded resources
        • Emplacement
        • File localization
        • Text localization
        • Printing templates
    • Avalanche.Memory
      • Introduction
      • IMemory<T>
      • BlockMemory<T>
      • FileMemory
      • ListMemory<L, T>
      • MemoryMemory<T>
      • MMFMemory<T>
      • PointerMemory<T>
      • Slice<M, T>
      • StreamMemory
      • Concurrency
        • RWLockedMemory
        • SynchronizedMemory
      • Serialization
        • Benchmarks
        • Fixed<T>
        • Variable<T>
        • ZigZag<T>
        • StringEncoding
      • Articles
        • Fixed-size and Variable-sized
        • IBlockPool<T>
        • Print Tree
        • Read and Write events
        • Stream View
        • Zero Heap
    • Avalanche.Message
      • Introduction
      • IMessage
      • IMessageProvider
      • IMessageDescription
      • IMessageDescriptions
      • MessageDescriptionsBase
      • MessageLevel
      • Message printing
      • Messages and Exceptions
      • Microsoft.Extensions
        • DependencyInjection
      • Articles
        • Aggregate Messages
        • Localization
        • Localization Templates
        • Logging
        • Validation
    • Avalanche.Module
      • Introduction
      • IServiceCollection
      • IServiceBuilder
      • IHostBuilder
      • Dependencies
    • Avalanche.Options
      • Introduction
      • OptionsExtensions
      • OptionsMonitorCast
    • Avalanche.Protobuf
      • Introduction
    • Avalanche.Service
      • Introduction
      • Service
        • Introduction
        • IService
        • IServiceDisposable
        • IServiceDecoration
        • IServiceCast
        • IServiceObservable
        • IServiceContainer
        • Construction
        • Query
        • CancellationToken
        • CachePolicy
        • Scope
      • Handler
        • Introduction
        • IHandler
        • IHandlerCast
        • IHandlerDecoration
        • IHandlerWithOrder
        • CancellationToken
        • Cyclicity
        • Delegates
        • Invokable
        • ExportAttribute
        • OrderAttribute
        • PrintTree
        • Recursion
      • Query
        • Introduction
        • IQuery
        • IQueryCast
        • IQueryDecoration
      • Entry
        • Introduction
        • IEntry
        • IEntryCast
        • IEntryDecoration
        • IEntryObservable
        • IEntryVisitable
        • EntryState
      • Request
        • Introduction
        • IRequest
        • IRequestFor
        • IRequestToBeCached
        • IRequestToBeDisposed
        • RequestAttribute
        • ContextParameterAttribute
        • Print Tree
      • Dependency Injection
        • Introduction
        • Asp.Net
        • ServiceRequest<T>
        • Decorating a service
        • Handler
        • CachePolicy
        • CancellationToken
        • QueryLogger
        • IHostBuilder
      • Examples
        • NodeCount
        • Expression
        • Mapper
      • Articles
        • Benchmarks
        • Error Handling
        • ServiceMessages
    • Avalanche.StatusCode
      • Introduction
      • HResult
        • Introduction
        • HResult.Facilities
        • BasicMessages
        • RpcMessages
        • DispatchMessages
        • StorageMessages
        • ItfMessages
        • Win32Messages
        • WindowsMessages
        • SspiMessages
        • CertMessages
        • MediaServerMessages
        • SetupApiMessages
        • ScardMessages
        • ComPlusMessages
        • ClrMessages
        • UserModeFilterManagerMessages
        • GraphicsMessages
        • TpmServicesMessages
        • TpmSoftwareMessages
        • PlaMessages
        • FveMessages
        • FwpMessages
        • NdisMessages
        • DltMessages
      • System
        • Introduction
        • AccessControlMessages
        • AggregateMessages
        • AppDomainMessages
        • ArgumentMessages
        • ArgumentNullMessages
        • ArgumentOutOfRangeMessages
        • ArithmeticMessages
        • ArrayMessages
        • AssemblyMessages
        • BadImageFormatMessages
        • CodeContractMessages
        • CodePageMessages
        • CollectionsMessages
        • CompilerServiceMessages
        • CryptographyMessages
        • CultureMessages
        • DiagnosticsMessages
        • EventSourceMessages
        • ExecutionEngineMessages
        • FormatMessages
        • HostProtectionMessages
        • IOMessages
        • IndexOutOfRangeMessages
        • InteropServiceMessages
        • InvalidCastMessages
        • InvalidOperationMessages
        • IsolatedStorageMessages
        • LazyMessages
        • MarshalerMessages
        • MemoryMessages
        • MiscellaneousMessages
        • NotImplementedMessages
        • NotSupportedMessages
        • ObjectDisposedMessages
        • OperationCanceledMessages
        • OverflowMessages
        • PlatformMessages
        • PolicyMessages
        • PrincipalMessages
        • ProgramMessages
        • ReferenceMessages
        • ReflectionMessages
        • RegionMessages
        • RemotingMessages
        • ResourcesMessages
        • SecurityMessages
        • SerializationMessages
        • StackMessages
        • TaskMessages
        • TextMessages
        • ThreadingMessages
        • TimeZoneMessages
        • TypeMessages
        • XmlMessages
      • HttpStatusCode
      • OpcUaStatusCode
    • Avalanche.Template
      • Introduction
      • TemplateFormats
      • ITemplatePrintable
      • ITemplateFormatPrintable
      • ITemplateText
      • ITemplateBreakdown
      • ITemplateFormat
      • ITemplateFormats
      • Extract Arguments
      • Emplacement
    • Avalanche.Tokenizer
      • Introduction
      • IToken
      • ITokenizer
      • Tokenizers
    • Avalanche.Utilities
      • Introduction
      • Collections
        • ArrayList
        • ArrayUtilities
        • BijectionMap
        • CachedSelect
        • DictionaryAdapter
        • EnumerableExtensions
        • LocakableDictionary
        • LockableList
        • MapList
        • Pipe
        • RingQueue
        • StructList
        • Tuples
        • TupleUtilities
      • Comparers
        • IGraphComparer
        • IGraphComparable
        • AlphaNumericComparer
        • EnumerableComparer
        • EnumerableGraphComparer
        • ReferenceComparer
        • KeyValuePairComparer
        • DefaultComparerProvider
        • RecordComparer
      • Cloners
        • ICloner
        • IGraphCloner
        • IGraphCloneable
        • ListCloner
        • DictionaryCloner
        • FieldCloner
        • PassthroughCloner
        • RecordCloner
        • ClonerProvider
      • Dispose
        • IDisposeAttachable
        • IDisposeBelatable
      • Provider
        • Introduction
        • ProviderBase
        • Delegate
        • Pipe
        • Cache
        • ResultCapture
        • AsReadOnly
        • SharedResource
        • AsService
        • IProviderEvent
      • Record
        • IRecordDescription
        • IFieldDescription
        • IConstructorDescription
        • IConstructionDescription
        • IParameterDescription
        • IRecordProviders
        • RecordDelegates
          • RecordCreate
          • RecordClone
          • RecordCopy
          • IRecordDelegates
        • FieldDelegates
          • FieldRead
          • FieldWrite
          • RecreateWith
          • IFieldDelegates
      • Reflection
        • EnumDescription
      • String
        • IEscaper
        • UnicodeString
        • Hex
      • Miscellaneous
        • IIdGenerator
        • Permutation
        • IReadOnly
        • IUserDataContainer
        • ITreeNode
        • Void
    • Avalanche.Writer
      • Introduction
      • ConstantWriter
      • Context
      • ConvertWriter
      • DefaultConstructor
      • DelegateWriter
      • PassthroughWriter
      • Referer
      • TypeCast
      • Writer
      • WriterPipe
      • WriterMessages

    ILocalizationFiles

    ILocalizationFiles is table for managing file resources.

    /// <summary>Localization file properties and providers.</summary>
    public interface ILocalizationFiles
    {
        /// <summary>Localization file formats.</summary>
        /// <remarks>Reference to this field can used by the instances in <see cref="FileProviders"/>.</remarks>
        IList<ILocalizationFileFormat> FileFormats { get; set; }
        /// <summary>File systems.</summary>
        /// <remarks>Reference to this field can used by the instances in <see cref="FileProviders"/>.</remarks>
        IList<ILocalizationFileSystem> FileSystems { get; set; }
        /// <summary>File systems where file listings are cached. This enumerable is derived from <see cref="FileSystems"/> and contains cache decorated references.</summary>
        /// <remarks>Reference to this field can used by the instances in <see cref="FileProviders"/>.</remarks>
        IEnumerable<ILocalizationFileSystem> FileSystemsListCached { get; set; }
        /// <summary>File name patterns without extension, e.g. "{Culture}/{Namespace}". Template text can uses parameters: "Culture", "Namespace", "Name", "Key".</summary>
        /// <remarks>Reference to this field can used by file provider instances.</remarks>
        IList<ITemplateFormatPrintable> FilePatterns { get; set; }
        /// <summary>Explicitly assigned culture and key invariant localization files.</summary>
        /// <remarks>Reference to this field can used by the instances in <see cref="FileProviders"/>.</remarks>
        IList<ILocalizationFile> Files { get; set; }
        /// <summary>Localization file query providers</summary>
        IList<IProvider<(string? culture, string? key), IEnumerable<ILocalizationFile>>> FileProviders { get; set; }
        /// <summary>Localization file query providers</summary>
        IList<IProvider<(string? culture, string? key), IEnumerable<ILocalizationFile>>> FileProvidersCached { get; set; }
    
        /// <summary>Query provider that uses optional culture and key constraints. Sources content from the providers in <see cref="FileProviders"/>. (no caching)</summary>
        IProvider<(string? culture, string? key), IEnumerable<ILocalizationFile>> Query { get; set; }
        /// <summary>Query provider that uses optional culture and key constraints. Sources content from the providers in <see cref="FileProviders"/>. (cached)</summary>
        IProvider<(string? culture, string? key), IEnumerable<ILocalizationFile>> QueryCached { get; set; }
    }
    

    ILocalizationFiles is a property of ILocalization.

    ILocalization localization = new Localization();
    ILocalizationFiles localizationFiles = localization.Files;
    

    FileFormats is a list where supported file formats are managed.

    ILocalization localization = new Localization();
    ILocalizationFileFormat fileformat = LocalizationFileFormatYaml.Instance;
    localization.Files.FileFormats.Add(fileformat);
    

    FileSystems is a list where supported file systems are managed.

    ILocalization localization = new Localization();
    ILocalizationFileSystem filesystem = new LocalizationFileSystem(AppDomain.CurrentDomain.BaseDirectory, "ApplicationRoot");
    localization.Files.FileSystems.Add(filesystem);
    

    FilePatterns is a list where supported file patterns are managed.

    ILocalization localization = new Localization();
    ITemplateFormatPrintable pattern = new TemplateText("Resources/{Culture}/{Key}", TemplateFormat.BraceAlphaNumeric);
    localization.Files.FilePatterns.Add(pattern);
    

    Files is a list where explicit files are managed.

    ILocalization localization = new Localization();
    // Create file reference
    ILocalizationFile localizationFile = new LocalizationFile
    {
        FileName = "Resources/localization.l.yaml",
        FileSystem = LocalizationFileSystem.ApplicationRoot,
        FileFormat = LocalizationFileFormatYaml.Instance,
        Culture = "",
        Key = "Namespace"
    }.SetReadOnly();
    // Add localization file (reference)
    localization.Files.Files.Add(localizationFile);
    

    FileProviders and FileProvidersCached are lists where queryable file providers are managed. A cached and non-cached version of file provider must be added to both lists.

    // Create localization
    ILocalization localization = new Localization();
    // Create provider
    IProvider<(string? culture, string? key), IEnumerable<ILocalizationFile>> provider = 
        new ResourceManagerFileProvider(docs.Resources.Resource1.ResourceManager);
    // Add provider (both are required)
    localization.Files.FileProviders.Add(provider);
    localization.Files.FileProvidersCached.Add(provider.ValueResultCaptured().Cached().ValueResultOpened());
    // Get file reference
    ILocalizationFile localizationFile = localization.FileQueryCached[("", "docs.Resources.Resource1.logo")].FirstOrDefault()!;
    // Read file
    byte[] data = localizationFile.ReadFully();
    

    Query is concatenation of all the providers in the FileProviders property. This provider caches nothing and reads everything fresh from sources.

    // Get default localization
    ILocalization localization = Localization.Default;
    // Query
    IEnumerable<ILocalizationFile> files = localization.Files.QueryCached[("en", "Namespace.Apple")];
    

    QueryCached is concatenation of all the providers in the FileProvidersCache property. This provider caches the results and the source files.

    // Get default localization
    ILocalization localization = Localization.Default;
    // Query
    IEnumerable<ILocalizationFile> files = localization.Files.QueryCached[("en", "Namespace.Apple")];
    

    Full Example

    Full example
    using Avalanche.Localization;
    using Avalanche.Template;
    using Avalanche.Utilities;
    using Avalanche.Utilities.Provider;
    
    public class localizationfiles
    {
        public static void Run()
        {
            {
                // <01>
                ILocalization localization = new Localization();
                ILocalizationFiles localizationFiles = localization.Files;
                // </01>
            }
            {
                // <02>
                ILocalization localization = new Localization();
                ILocalizationFileFormat fileformat = LocalizationFileFormatYaml.Instance;
                localization.Files.FileFormats.Add(fileformat);
                // </02>
            }
            {
                // <03>
                ILocalization localization = new Localization();
                ILocalizationFileSystem filesystem = new LocalizationFileSystem(AppDomain.CurrentDomain.BaseDirectory, "ApplicationRoot");
                localization.Files.FileSystems.Add(filesystem);
                // </03>
            }
            {
                // <04>
                ILocalization localization = new Localization();
                ITemplateFormatPrintable pattern = new TemplateText("Resources/{Culture}/{Key}", TemplateFormat.BraceAlphaNumeric);
                localization.Files.FilePatterns.Add(pattern);
                // </04>
            }
            {
                // <05>
                ILocalization localization = new Localization();
                // Create file reference
                ILocalizationFile localizationFile = new LocalizationFile
                {
                    FileName = "Resources/localization.l.yaml",
                    FileSystem = LocalizationFileSystem.ApplicationRoot,
                    FileFormat = LocalizationFileFormatYaml.Instance,
                    Culture = "",
                    Key = "Namespace"
                }.SetReadOnly();
                // Add localization file (reference)
                localization.Files.Files.Add(localizationFile);
                // </05>
            }
            {
                // <06>
                // Create localization
                ILocalization localization = new Localization();
                // Create provider
                IProvider<(string? culture, string? key), IEnumerable<ILocalizationFile>> provider = 
                    new ResourceManagerFileProvider(docs.Resources.Resource1.ResourceManager);
                // Add provider (both are required)
                localization.Files.FileProviders.Add(provider);
                localization.Files.FileProvidersCached.Add(provider.ValueResultCaptured().Cached().ValueResultOpened());
                // Get file reference
                ILocalizationFile localizationFile = localization.FileQueryCached[("", "docs.Resources.Resource1.logo")].FirstOrDefault()!;
                // Read file
                byte[] data = localizationFile.ReadFully();
                // </06>
            }
            {
                // <07>
                // Get default localization
                ILocalization localization = Localization.Default;
                // Query
                IEnumerable<ILocalizationFile> files = localization.Files.QueryCached[("en", "Namespace.Apple")];
                // </07>
            }
            {
                // <08>
                // Get default localization
                ILocalization localization = Localization.Default;
                // Query
                IEnumerable<ILocalizationFile> files = localization.Files.QueryCached[("en", "Namespace.Apple")];
                // </08>
            }
        }
    }
    
    In This Article
    Back to top