src/SubLib/Core/Domain/SubtitleTypeInfo.cs

   1 /*
   2  * This file is part of SubLib.
   3  * Copyright (C) 2006-2008,2011 Pedro Castro
   4  *
   5  * SubLib is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * SubLib is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 using SubLib.IO.SubtitleFormats;
  21 using System;
  22
  23 namespace SubLib.Core.Domain {
  24
  25 /// <summary>Contains information about a subtitle file type.</summary>
  26 public class SubtitleTypeInfo : IComparable {
  27         private string name;
  28         private SubtitleType type;
  29         private SubtitleMode mode;
  30         private string[] extensions;
  31
  32
  33         /// <summary>Initializes a new instance of the <see cref="SubtitleTypeInfo" /> class.</summary>
  34         /// <param name="name">The name of the subtitle type.</param>
  35         /// <param name="type">The subtitle type.</param>
  36         /// <param name="mode">The subtitle mode.</param>
  37         /// <param name="extensions">The extensions the subtitle type uses.</param>
  38         public SubtitleTypeInfo (string name, SubtitleType type, SubtitleMode mode, string[] extensions) {
  39                 this.name = name;
  40                 this.type = type;
  41                 this.mode = mode;
  42                 this.extensions = extensions;
  43         }
  44
  45         /// <summary>The name of the subtitle type.</summary>
  46         public string Name {
  47                 get { return name; }
  48         }
  49
  50         /// <summary>The subtitle type.</summary>
  51         public SubtitleType Type {
  52                 get { return type; }
  53         }
  54
  55         /// <summary>The subtitle mode.</summary>
  56         public SubtitleMode Mode {
  57                 get { return mode; }
  58         }
  59
  60         /// <summary>The extensions the subtitle type uses.</summary>
  61         public string[] Extensions {
  62                 get { return extensions; }
  63         }
  64
  65         /// <summary>A comma-separated list of the extensions the subtitle type uses.
  66         /// The prefix "*." is added to every extension.</summary>
  67         public string ExtensionsAsText {
  68                 get { return ExtensionsToText(); }
  69         }
  70
  71         /// <summary>The preferred extension, which is the first on the list.</summary>
  72         public string PreferredExtension {
  73                 get { return extensions[0]; }
  74         }
  75
  76         /// <summary>Checks whether the specified extension is one of the extensions of the <see cref="SubtitleType" /></summary>
  77         /// <param name="extension">The extension to search for.</param>
  78         /// <returns>True if the extension was found, False otherwise.</returns>
  79         public bool HasExtension (string extension) {
  80                 foreach (string typeExtension in extensions) {
  81                         if (typeExtension == extension)
  82                                 return true;
  83                 }
  84                 return false;
  85         }
  86
  87         /// <summary>Compares this instance with a specified object, based on the object names.
  88         /// See <see cref="String.CompareTo(object)" /> for more information.</summary>
  89         /// <param name="obj">The object to compare this class to.</param>
  90         /// <returns>
  91         /// <list type="table">
  92     ///                 <listheader><term>Value</term><description>Condition</description></listheader>
  93     ///         <item><term>Less than zero</term><description>This instance is less than obj.</description></item>
  94     ///         <item><term>Zero</term><description>This instance is equal to obj.</description></item>
  95     ///         <item><term>Greater than zero</term><description>This instance is greater than obj, or obj is a
  96     ///                 null reference.</description></item>
  97         ///     </list>
  98         ///     </returns>
  99         public int CompareTo (object obj) {
 100                 return Name.CompareTo((obj as SubtitleTypeInfo).Name);
 101         }
 102
 103         /* Internal members */
 104
 105         internal SubtitleTypeInfo (SubtitleFormat format) : this(format.Name, format.Type, format.Mode, format.Extensions) {
 106         }
 107
 108         /* Private members */
 109
 110         private string ExtensionsToText () {
 111                 if (extensions == null)
 112                         return String.Empty;
 113
 114                 string text = ExtensionToText(extensions[0]);
 115                 for (int count = 1 ; count < extensions.Length ; count++)
 116                         text += ", " + ExtensionToText(extensions[count]);
 117
 118                 return text;
 119         }
 120
 121         private string ExtensionToText (string extension) {
 122                 return "*." + extension;
 123         }
 124 }
 125
 126 }