clsLanguageFile.cs

// C# ClassLib
// http://csharp-classlib.sourceforge.net
//
//
// Copyright (C) 2005 Marcel Joachim Kloubert
// 
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//

using System;
using System.IO;
using System.Xml;
using System.Xml.XPath;

namespace CSharp_ClassLib.Classes
{
        public class LanguageFile : System.Object
        {
        private System.Xml.XmlDocument m_oXMLDocument;
                
                private System.Collections.ArrayList m_oLanguageEntries;
                
                private string m_strAuthor;
                private string m_strEmail;
                private string m_strHomepage;
                private string m_strCaptionOriginal;
                private string m_strCaptionEnglish;
                
            private const string XML_TAG_ROOT =  "language_file";
                private const string XML_TAG_INFORMATION =  "information";
                private const string XML_TAG_ENTRIES =  "entries";      
                
                private const string XML_TAG_AUTHOR =  "author";
                private const string XML_TAG_EMAIL =  "email";
                private const string XML_TAG_HOMEPAGE =  "homepage";
                private const string XML_TAG_LANGUAGE_CAPTION_ORIGINAL =  "caption_org";
                private const string XML_TAG_LANGUAGE_CAPTION_ENGLISH =  "caption_eng";
        
                private const string XML_ATTRIBUTE_ID =  "id";
                private const string XML_ATTRIBUTE_CATEGORY =  "category";
                
                private const string XPATH_ALL_INFORMATION = "/" + XML_TAG_ROOT + "//" + XML_TAG_INFORMATION + "/child::*";
                private const string XPATH_ALL_ENTRIES = "/" + XML_TAG_ROOT + "//" + XML_TAG_ENTRIES + "/child::*";
                
                public LanguageFile ()
                {
                        this.InitRest();
                        
                        return;
                }
        
                public LanguageFile (string Language_File)
                {
                        this.InitRest();
                        
                        this.LoadFromFile(Language_File);
                        
                        return;
                }
                
                public string Author { get { return m_strAuthor; } }
                
                public string Email { get { return m_strEmail; } }
                
                public string Homepage { get { return m_strHomepage; } }
                
                public string OriginalCaption { get { return m_strCaptionOriginal; } }
                
                public string EnglishCaption { get { return m_strCaptionEnglish; } }
                
                public CSharp_ClassLib.Classes.LanguageEntry[] Entries
                {
                        get
                        {
                                CSharp_ClassLib.Classes.LanguageEntry[] oBuffer = new CSharp_ClassLib.Classes.LanguageEntry[m_oLanguageEntries.Count];
                                m_oLanguageEntries.CopyTo(oBuffer);
                                
                                return oBuffer;
                        }
                }
                
                private void InitRest ()
                {
                        m_oXMLDocument = null;
                        
                        m_strAuthor = "";
                        m_strEmail = "";
                        m_strHomepage = "";
                        m_strCaptionOriginal = "";
                        m_strCaptionEnglish = "";
                        
                        m_oLanguageEntries = new System.Collections.ArrayList();
                        
                        return;
                }
                
                public void LoadFromFile (string Language_File)
                {
                        if (!System.IO.File.Exists(Language_File))
                                // file not found!
                                throw ( new System.IO.FileNotFoundException("Language file not found!", Language_File) );
                        
                // first create a temp document
                        System.Xml.XmlDocument oTEMPXMLDocument = new System.Xml.XmlDocument();                 
                        // init a new XPath document
                System.Xml.XPath.XPathDocument oXPathDocument = new System.Xml.XPath.XPathDocument(Language_File);
        
                try
                {
                        oTEMPXMLDocument.Load(Language_File);
        
                        // first read infos
                        this.ReadLanguageFileInformation(oXPathDocument);
                        // then read data
                        this.ReadLanguageFileEntries(oXPathDocument);   
                        
                        m_oXMLDocument = oTEMPXMLDocument;
                }
                catch (System.Exception e)
                {
                        throw (e);
                }
                
                return;
                }
                
                private void ReadLanguageFileInformation (System.Xml.XPath.XPathDocument XPath_Document)
                {
                        if (null == XPath_Document)
                                // argument is null!
                                throw ( new System.ArgumentNullException("XPath_Document", "Argument must not be null!") );
                        
                System.Xml.XPath.XPathNavigator oXMLPathNav = XPath_Document.CreateNavigator();
                System.Xml.XPath.XPathNodeIterator oXMLNodeIterator = oXMLPathNav.Select(XPATH_ALL_INFORMATION);
        
                while ( oXMLNodeIterator.MoveNext() )
                {
                switch (oXMLNodeIterator.Current.Name.ToLower().Trim())
                {
                        // author name
                        case XML_TAG_AUTHOR:
                                m_strAuthor = oXMLNodeIterator.Current.Value.Trim();
                                break;
                        
                        // author email
                        case XML_TAG_EMAIL:
                                m_strEmail = oXMLNodeIterator.Current.Value.Trim();
                                break;
                        
                        // author homepage
                        case XML_TAG_HOMEPAGE:
                                m_strHomepage = oXMLNodeIterator.Current.Value.Trim();
                                break;
                        
                        // original caption of the language
                        case XML_TAG_LANGUAGE_CAPTION_ORIGINAL:
                                m_strCaptionOriginal = oXMLNodeIterator.Current.Value.Trim();
                                break;
                                
                        // english caption of the language
                        case XML_TAG_LANGUAGE_CAPTION_ENGLISH:
                                m_strCaptionEnglish = oXMLNodeIterator.Current.Value.Trim();
                                break;
                }            
                }
        
                return;                 
                }
        
                private void ReadLanguageFileEntries (System.Xml.XPath.XPathDocument XPath_Document)
                {
                        if (null == XPath_Document)
                                // argument is null!
                                throw ( new System.ArgumentNullException("XPath_Document", "Argument must not be null!") );
                        
                try
                {
                                // Create temporary language entry list
                        System.Collections.ArrayList m_oTempLanguageEntries = new System.Collections.ArrayList();
        
                        System.Xml.XPath.XPathNavigator oXMLPathNav = XPath_Document.CreateNavigator();
                        System.Xml.XPath.XPathNodeIterator oXMLNodeIterator = oXMLPathNav.Select(XPATH_ALL_ENTRIES);
                
                        // Temporary language entry
                        CSharp_ClassLib.Classes.LanguageEntry oTMPEntry;
        
                        while ( oXMLNodeIterator.MoveNext() )
                        {
                        switch ( oXMLNodeIterator.Current.Name.ToLower().Trim() )
                        {
                                case "entry":
                                // first store data in a temporary LanguageEntry instance
                                oTMPEntry = new CSharp_ClassLib.Classes.LanguageEntry();
                                oTMPEntry.ID = oXMLNodeIterator.Current.GetAttribute(XML_ATTRIBUTE_ID, "");
                                oTMPEntry.Category = oXMLNodeIterator.Current.GetAttribute(XML_ATTRIBUTE_CATEGORY, "");
                                oTMPEntry.Value = oXMLNodeIterator.Current.Value;
                    
                                // add temp instance to list
                                m_oTempLanguageEntries.Add(oTMPEntry);
                                break;
                        }            
                        }
                        
                        m_oLanguageEntries = m_oTempLanguageEntries;
                }
                catch (System.Exception e)
                {
                        throw(e);
                }
                
                return;                 
                }
        
        public string GetValue (string ID, bool ThrowException)
        {       
                return this.GetValue(ID, "", ThrowException);
        }
                
        public string GetValue (string ID, string Category, bool ThrowException)
        {       
                int i = 0;
                
                for (i = 0; i < this.m_oLanguageEntries.Count; i++)
                {
                if ( (((CSharp_ClassLib.Classes.LanguageEntry)m_oLanguageEntries[i]).Category == Category) && (((CSharp_ClassLib.Classes.LanguageEntry)m_oLanguageEntries[i]).ID == ID) )
                        // entry found
                        return ((CSharp_ClassLib.Classes.LanguageEntry)m_oLanguageEntries[i]).Value;
                }
        
                // entry not found => use Default value or throw exception
                if (ThrowException)
                        throw ( new System.ArgumentOutOfRangeException("ID; Category", "Entry was not found!") );
                
                return "";
        }
                
        public string GetValue (string ID, string Category, string Default)
        {       
                int i = 0;
                
                for (i = 0; i < this.m_oLanguageEntries.Count; i++)
                {
                if ( (((CSharp_ClassLib.Classes.LanguageEntry)m_oLanguageEntries[i]).Category == Category) && (((CSharp_ClassLib.Classes.LanguageEntry)m_oLanguageEntries[i]).ID == ID) )
                        // entry found
                        return ((CSharp_ClassLib.Classes.LanguageEntry)m_oLanguageEntries[i]).Value;
                }
        
                // entry not found => use Default value
                return Default;
        }
                
        public string GetValue (string ID, string Category)
        {       
                return this.GetValue(ID, Category, "");
        }
                
        public string GetValue (string ID)
        {       
                return this.GetValue(ID, "", "");
        }
        }

        public class LanguageEntry : System.Object
        {
        string m_strID = "";
        string m_strCategory = "";
        string m_strValue = "";
                
        public LanguageEntry()
        {
                Category = "";
                ID = "";
                Value = "";
            
                return;
        }
        
        public LanguageEntry(string category)
        {
                Category = category;
                ID = "";
                Value = "";
            
                return;
        }
        
        public LanguageEntry(string category, string id)
        {
                Category = category;
                ID = id;
                Value = "";
            
                return;
        }
        
        public LanguageEntry(string category, string id, string value)
        {
                Category = category;
                ID = id;
                Value = value;
            
                return;
        }
        
        public string ID
        {
                get { return m_strID; }
                set { m_strID = value; return; }
        }
        
        public string Category
        {
                get { return m_strCategory; }
                set { m_strCategory = value; return; }
        }
        
        public string Value
        {
                get { return m_strValue; }
                set { m_strValue = value; return; }
        }
        }       
}

---