Add tar streams.

[wxWidgets.git] / include / wx / mimetype.h

diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h
index 773d4a76728cd76a33f2424d59861d6feeee5ab9..59369ba56518bdb2a91f411b15546afb4f16c6a6 100644 (file)
--- a/include/wx/mimetype.h
+++ b/include/wx/mimetype.h
@@ -7,16 +7,12 @@
 // Created:     23.09.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     23.09.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license (part of wxExtra library)
+// Licence:     wxWindows licence (part of wxExtra library)

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MIMETYPE_H_
 #define _WX_MIMETYPE_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MIMETYPE_H_
 #define _WX_MIMETYPE_H_
 

-#ifdef __GNUG__
-    #pragma interface "mimetypebase.h"
-#endif // __GNUG__
-

 // ----------------------------------------------------------------------------
 // headers and such
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers and such
 // ----------------------------------------------------------------------------


@@ -28,11 +24,12 @@
 // the things we really need
 #include "wx/string.h"
 #include "wx/dynarray.h"
 // the things we really need
 #include "wx/string.h"
 #include "wx/dynarray.h"

+#include "wx/arrstr.h"

 
 // fwd decls
 
 // fwd decls

-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxFileTypeImpl;
-class WXDLLEXPORT wxMimeTypesManagerImpl;
+class WXDLLIMPEXP_BASE wxIconLocation;
+class WXDLLIMPEXP_BASE wxFileTypeImpl;
+class WXDLLIMPEXP_BASE wxMimeTypesManagerImpl;

 
 // these constants define the MIME informations source under UNIX and are used
 // by wxMimeTypesManager::Initialize()
 
 // these constants define the MIME informations source under UNIX and are used
 // by wxMimeTypesManager::Initialize()


@@ -49,7 +46,7 @@ enum wxMailcapStyle
 /*
     TODO: would it be more convenient to have this class?
 
 /*
     TODO: would it be more convenient to have this class?
 

-class WXDLLEXPORT wxMimeType : public wxString
+class WXDLLIMPEXP_BASE wxMimeType : public wxString

 {
 public:
     // all string ctors here
 {
 public:
     // all string ctors here


@@ -70,21 +67,95 @@ public:
 
 */
 
 
 */
 

+// wxMimeTypeCommands stores the verbs defined for the given MIME type with
+// their values
+class WXDLLIMPEXP_BASE wxMimeTypeCommands
+{
+public:
+    wxMimeTypeCommands() {}
+
+    wxMimeTypeCommands(const wxArrayString& verbs,
+                       const wxArrayString& commands)
+        : m_verbs(verbs),
+          m_commands(commands)
+    {
+    }
+
+    // add a new verb with the command or replace the old value
+    void AddOrReplaceVerb(const wxString& verb, const wxString& cmd)
+    {
+        int n = m_verbs.Index(verb, false /* ignore case */);
+        if ( n == wxNOT_FOUND )
+        {
+            m_verbs.Add(verb);
+            m_commands.Add(cmd);
+        }
+        else
+        {
+            m_commands[n] = cmd;
+        }
+    }
+
+    void Add(const wxString& s)
+    {
+        m_verbs.Add(s.BeforeFirst(wxT('=')));
+        m_commands.Add(s.AfterFirst(wxT('=')));
+    }
+
+    // access the commands
+    size_t GetCount() const { return m_verbs.GetCount(); }
+    const wxString& GetVerb(size_t n) const { return m_verbs[n]; }
+    const wxString& GetCmd(size_t n) const { return m_commands[n]; }
+
+    bool HasVerb(const wxString& verb) const
+        { return m_verbs.Index(verb) != wxNOT_FOUND; }
+
+    wxString GetCommandForVerb(const wxString& verb, size_t *idx = NULL) const
+    {
+        wxString s;
+
+        int n = m_verbs.Index(verb);
+        if ( n != wxNOT_FOUND )
+        {
+            s = m_commands[(size_t)n];
+            if ( idx )
+                *idx = n;
+        }
+        else if ( idx )
+        {
+            // different from any valid index
+            *idx = (size_t)-1;
+        }
+
+        return s;
+    }
+
+    // get a "verb=command" string
+    wxString GetVerbCmd(size_t n) const
+    {
+        return m_verbs[n] + wxT('=') + m_commands[n];
+    }
+
+private:
+    wxArrayString m_verbs;
+    wxArrayString m_commands;
+};
+

 // ----------------------------------------------------------------------------
 // wxFileTypeInfo: static container of information accessed via wxFileType.
 //
 // This class is used with wxMimeTypesManager::AddFallbacks() and Associate()
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxFileTypeInfo: static container of information accessed via wxFileType.
 //
 // This class is used with wxMimeTypesManager::AddFallbacks() and Associate()
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFileTypeInfo
+class WXDLLIMPEXP_BASE wxFileTypeInfo

 {
 public:
     // ctors
         // a normal item
 {
 public:
     // ctors
         // a normal item

-    wxFileTypeInfo(const char *mimeType,
-                   const char *openCmd,
-                   const char *printCmd,
-                   const char *desc,
+    wxFileTypeInfo(const wxChar *mimeType,
+                   const wxChar *openCmd,
+                   const wxChar *printCmd,
+                   const wxChar *desc,

                    // the other parameters form a NULL terminated list of
                    // extensions
                    ...);
                    // the other parameters form a NULL terminated list of
                    // extensions
                    ...);


@@ -98,7 +169,7 @@ public:
     wxFileTypeInfo() { }
 
     // test if this object can be used
     wxFileTypeInfo() { }
 
     // test if this object can be used

-    bool IsValid() const { return !m_mimeType.IsEmpty(); }
+    bool IsValid() const { return !m_mimeType.empty(); }

 
     // setters
         // set the icon info
 
     // setters
         // set the icon info


@@ -123,7 +194,7 @@ public:
     const wxString& GetDescription() const { return m_desc; }
         // get the array of all extensions
     const wxArrayString& GetExtensions() const { return m_exts; }
     const wxString& GetDescription() const { return m_desc; }
         // get the array of all extensions
     const wxArrayString& GetExtensions() const { return m_exts; }

-    int GetExtensionsCount() const {return m_exts.GetCount(); }
+    size_t GetExtensionsCount() const {return m_exts.GetCount(); }

         // get the icon info
     const wxString& GetIconFile() const { return m_iconFile; }
     int GetIconIndex() const { return m_iconIndex; }
         // get the icon info
     const wxString& GetIconFile() const { return m_iconFile; }
     int GetIconIndex() const { return m_iconIndex; }


@@ -149,7 +220,8 @@ private:
 #endif // 0
 };
 
 #endif // 0
 };
 

-WX_DECLARE_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo,
+                                  WXDLLIMPEXP_BASE);

 
 // ----------------------------------------------------------------------------
 // wxFileType: gives access to all information about the files of given type.
 
 // ----------------------------------------------------------------------------
 // wxFileType: gives access to all information about the files of given type.


@@ -162,9 +234,9 @@ WX_DECLARE_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo);
 // the accessors *must* be checked!
 // ----------------------------------------------------------------------------
 
 // the accessors *must* be checked!
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFileType
+class WXDLLIMPEXP_BASE wxFileType

 {
 {

-friend class WXDLLEXPORT wxMimeTypesManagerImpl;  // it has access to m_impl
+friend class WXDLLIMPEXP_BASE wxMimeTypesManagerImpl;  // it has access to m_impl

 
 public:
     // An object of this class must be passed to Get{Open|Print}Command. The
 
 public:
     // An object of this class must be passed to Get{Open|Print}Command. The


@@ -177,7 +249,7 @@ public:
         // ctors
         MessageParameters() { }
         MessageParameters(const wxString& filename,
         // ctors
         MessageParameters() { }
         MessageParameters(const wxString& filename,

-                          const wxString& mimetype = _T(""))
+                          const wxString& mimetype = wxEmptyString)

             : m_filename(filename), m_mimetype(mimetype) { }
 
         // accessors (called by GetOpenCommand)
             : m_filename(filename), m_mimetype(mimetype) { }
 
         // accessors (called by GetOpenCommand)


@@ -209,12 +281,10 @@ public:
         // fill passed in array with all extensions associated with this file
         // type
     bool GetExtensions(wxArrayString& extensions);
         // fill passed in array with all extensions associated with this file
         // type
     bool GetExtensions(wxArrayString& extensions);

-        // get the icon corresponding to this file type, the name of the file
-        // where the icon resides is return in iconfile if !NULL and its index
-        // in this file (Win-only) is in iconIndex
-    bool GetIcon(wxIcon *icon,
-                 wxString *iconFile = NULL,
-                 int *iconIndex = NULL) const;
+        // get the icon corresponding to this file type and of the given size
+    bool GetIcon(wxIconLocation *iconloc) const;
+    bool GetIcon(wxIconLocation *iconloc,
+                 const MessageParameters& params) const;

         // get a brief file type description ("*.txt" => "text document")
     bool GetDescription(wxString *desc) const;
 
         // get a brief file type description ("*.txt" => "text document")
     bool GetDescription(wxString *desc) const;
 


@@ -235,9 +305,9 @@ public:
                           const wxFileType::MessageParameters& params) const;
 
     // set an arbitrary command, ask confirmation if it already exists and
                           const wxFileType::MessageParameters& params) const;
 
     // set an arbitrary command, ask confirmation if it already exists and

-    // overwriteprompt is TRUE
+    // overwriteprompt is true

     bool SetCommand(const wxString& cmd, const wxString& verb,
     bool SetCommand(const wxString& cmd, const wxString& verb,

-        bool overwriteprompt = TRUE);
+        bool overwriteprompt = true);

 
     bool SetDefaultIcon(const wxString& cmd = wxEmptyString, int index = 0);
 
 
     bool SetDefaultIcon(const wxString& cmd = wxEmptyString, int index = 0);
 


@@ -274,6 +344,25 @@ private:
     wxFileTypeImpl *m_impl;
 };
 
     wxFileTypeImpl *m_impl;
 };
 

+//----------------------------------------------------------------------------
+// wxMimeTypesManagerFactory
+//----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxMimeTypesManagerFactory
+{
+public:
+    wxMimeTypesManagerFactory() {}
+    virtual ~wxMimeTypesManagerFactory() {}
+
+    virtual wxMimeTypesManagerImpl *CreateMimeTypesManagerImpl();
+
+    static void Set( wxMimeTypesManagerFactory *factory );
+    static wxMimeTypesManagerFactory *Get();
+    
+private:
+    static wxMimeTypesManagerFactory *m_factory;
+};
+

 // ----------------------------------------------------------------------------
 // wxMimeTypesManager: interface to system MIME database.
 //
 // ----------------------------------------------------------------------------
 // wxMimeTypesManager: interface to system MIME database.
 //


@@ -282,7 +371,7 @@ private:
 // given type) about them.
 // ----------------------------------------------------------------------------
 
 // given type) about them.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxMimeTypesManager
+class WXDLLIMPEXP_BASE wxMimeTypesManager

 {
 public:
     // static helper functions
 {
 public:
     // static helper functions


@@ -291,7 +380,7 @@ public:
         // check if the given MIME type is the same as the other one: the
         // second argument may contain wildcards ('*'), but not the first. If
         // the types are equal or if the mimeType matches wildcard the function
         // check if the given MIME type is the same as the other one: the
         // second argument may contain wildcards ('*'), but not the first. If
         // the types are equal or if the mimeType matches wildcard the function

-        // returns TRUE, otherwise it returns FALSE
+        // returns true, otherwise it returns false

     static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
 
     // ctor
     static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
 
     // ctor


@@ -305,7 +394,7 @@ public:
     //
     // use the extraDir parameter if you want to look for files in another
     // directory
     //
     // use the extraDir parameter if you want to look for files in another
     // directory

-    void Initialize(int mailcapStyle = wxMAILCAP_STANDARD,
+    void Initialize(int mailcapStyle = wxMAILCAP_ALL,

                     const wxString& extraDir = wxEmptyString);
 
     // and this function clears all the data from the manager
                     const wxString& extraDir = wxEmptyString);
 
     // and this function clears all the data from the manager


@@ -320,20 +409,20 @@ public:
         // get file type from MIME type (in format <category>/<format>)
     wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
 
         // get file type from MIME type (in format <category>/<format>)
     wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
 

-    // other operations: return TRUE if there were no errors or FALSE if there
-    // were some unreckognized entries (the good entries are always read anyhow)
+    // other operations: return true if there were no errors or false if there
+    // were some unrecognized entries (the good entries are always read anyhow)

     //
     // FIXME: These ought to be private ??
 
         // read in additional file (the standard ones are read automatically)
         // in mailcap format (see mimetype.cpp for description)
         //
     //
     // FIXME: These ought to be private ??
 
         // read in additional file (the standard ones are read automatically)
         // in mailcap format (see mimetype.cpp for description)
         //

-        // 'fallback' parameter may be set to TRUE to avoid overriding the
+        // 'fallback' parameter may be set to true to avoid overriding the

         // settings from other, previously parsed, files by this one: normally,
         // the files read most recently would override the older files, but with
         // settings from other, previously parsed, files by this one: normally,
         // the files read most recently would override the older files, but with

-        // fallback == TRUE this won't happen
+        // fallback == true this won't happen

 
 

-    bool ReadMailcap(const wxString& filename, bool fallback = FALSE);
+    bool ReadMailcap(const wxString& filename, bool fallback = false);

         // read in additional file in mime.types format
     bool ReadMimeTypes(const wxString& filename);
 
         // read in additional file in mime.types format
     bool ReadMimeTypes(const wxString& filename);
 


@@ -344,7 +433,7 @@ public:
 
     // these functions can be used to provide default values for some of the
     // MIME types inside the program itself (you may also use
 
     // these functions can be used to provide default values for some of the
     // MIME types inside the program itself (you may also use

-    // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to
+    // ReadMailcap(filenameWithDefaultTypes, true /* use as fallback */) to

     // achieve the same goal, but this requires having this info in a file).
     //
     // The filetypes array should be terminated by either NULL entry or an
     // achieve the same goal, but this requires having this info in a file).
     //
     // The filetypes array should be terminated by either NULL entry or an


@@ -388,8 +477,8 @@ private:
 // global variables
 // ----------------------------------------------------------------------------
 
 // global variables
 // ----------------------------------------------------------------------------
 

-// the default mime manager for wxWindows programs
-WXDLLEXPORT_DATA(extern wxMimeTypesManager *) wxTheMimeTypesManager;
+// the default mime manager for wxWidgets programs
+extern WXDLLIMPEXP_DATA_BASE(wxMimeTypesManager *) wxTheMimeTypesManager;

 
 #endif // wxUSE_MIMETYPE
 
 
 #endif // wxUSE_MIMETYPE