set eol-style

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

diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h
index dfa9d6caa23c9bea30e044fbf8e3df70dad61b7f..588b010b9ad7bc4d8b78c8cc549f3e0d3b5bf481 100644 (file)
--- a/include/wx/mimetype.h
+++ b/include/wx/mimetype.h
@@ -7,35 +7,48 @@
 // 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
 // ----------------------------------------------------------------------------
 
 #include "wx/defs.h"
 
 // ----------------------------------------------------------------------------
 // headers and such
 // ----------------------------------------------------------------------------
 
 #include "wx/defs.h"
 

+#if wxUSE_MIMETYPE
+

 // 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"
+
+#include <stdarg.h>

 
 // fwd decls
 
 // fwd decls

-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxFileTypeImpl;
-class WXDLLEXPORT wxMimeTypesManagerImpl;
+class WXDLLIMPEXP_FWD_BASE wxIconLocation;
+class WXDLLIMPEXP_FWD_BASE wxFileTypeImpl;
+class WXDLLIMPEXP_FWD_BASE wxMimeTypesManagerImpl;
+
+// these constants define the MIME informations source under UNIX and are used
+// by wxMimeTypesManager::Initialize()
+enum wxMailcapStyle
+{
+    wxMAILCAP_STANDARD = 1,
+    wxMAILCAP_NETSCAPE = 2,
+    wxMAILCAP_KDE = 4,
+    wxMAILCAP_GNOME = 8,
+
+    wxMAILCAP_ALL = 15
+};

 
 /*
     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


@@ -56,31 +69,155 @@ 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);
+    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; }
+
+    // returns empty string and wxNOT_FOUND in idx if no such verb
+    wxString GetCommandForVerb(const wxString& verb, size_t *idx = NULL) const;
+
+    // get a "verb=command" string
+    wxString GetVerbCmd(size_t n) const;
+
+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

 {
 {

+private:
+    void DoVarArgInit(const wxString& mimeType,
+                      const wxString& openCmd,
+                      const wxString& printCmd,
+                      const wxString& desc,
+                      va_list argptr);
+
+#if !wxUSE_UTF8_LOCALE_ONLY
+    void VarArgInitWchar(const wxChar *mimeType,
+                         const wxChar *openCmd,
+                         const wxChar *printCmd,
+                         const wxChar *desc,
+                         // the other parameters form a NULL terminated list of
+                         // extensions
+                         ...);
+#endif
+#if wxUSE_UNICODE_UTF8
+    void VarArgInitUtf8(const char *mimeType,
+                        const char *openCmd,
+                        const char *printCmd,
+                        const char *desc,
+                        // the other parameters form a NULL terminated list of
+                        // extensions
+                        ...);
+#endif

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

-    wxFileTypeInfo(const char *mimeType,
-                   const char *openCmd,
-                   const char *printCmd,
-                   const char *desc,
-                   // the other parameters form a NULL terminated list of
-                   // extensions
-                   ...);
+
+    // wxFileTypeInfo(const wxString& mimeType,
+    //               const wxString& openCmd,
+    //               const wxString& printCmd,
+    //               const wxString& desc,
+    //               // the other parameters form a list of extensions for this
+    //               // file type and should be terminated with wxNullPtr (not
+    //               // just NULL!)
+    //               ...);
+    WX_DEFINE_VARARG_FUNC_CTOR(wxFileTypeInfo,
+                               // NB: these are not format strings, using
+                               //     wxFormatString here is a hack to get
+                               //     implicit conversion to wchar_t*/char*
+                               4, (const wxFormatString&,
+                                   const wxFormatString&,
+                                   const wxFormatString&,
+                                   const wxFormatString&),
+                               VarArgInitWchar, VarArgInitUtf8)
+#ifdef __WATCOMC__
+    // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const wxString&,
+                                    const wxString&,
+                                    const wxString&,
+                                    const wxString&),
+                                (wxFormatString(f1),
+                                 wxFormatString(f2),
+                                 wxFormatString(f3),
+                                 wxFormatString(f4)));
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const wxCStrData&,
+                                    const wxCStrData&,
+                                    const wxCStrData&,
+                                    const wxCStrData&),
+                                (wxFormatString(f1),
+                                 wxFormatString(f2),
+                                 wxFormatString(f3),
+                                 wxFormatString(f4)));
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const char*,
+                                    const char*,
+                                    const char*,
+                                    const char*),
+                                (wxFormatString(f1),
+                                 wxFormatString(f2),
+                                 wxFormatString(f3),
+                                 wxFormatString(f4)));
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const wchar_t*,
+                                    const wchar_t*,
+                                    const wchar_t*,
+                                    const wchar_t*),
+                                (wxFormatString(f1),
+                                 wxFormatString(f2),
+                                 wxFormatString(f3),
+                                 wxFormatString(f4)));
+#endif
+
+        // the array elements correspond to the parameters of the ctor above in
+        // the same order
+    wxFileTypeInfo(const wxArrayString& sArray);

 
         // invalid item - use this to terminate the array passed to
         // wxMimeTypesManager::AddFallbacks
     wxFileTypeInfo() { }
 
     // test if this object can be used
 
         // invalid item - use this to terminate the array passed to
         // wxMimeTypesManager::AddFallbacks
     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


@@ -105,6 +242,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; }

+    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; }


@@ -122,6 +260,7 @@ private:
 
     wxArrayString m_exts;   // the extensions which are mapped on this filetype
 
 
     wxArrayString m_exts;   // the extensions which are mapped on this filetype
 

+

 #if 0 // TODO
     // the additional (except "open" and "print") command names and values
     wxArrayString m_commandNames,
 #if 0 // TODO
     // the additional (except "open" and "print") command names and values
     wxArrayString m_commandNames,


@@ -129,7 +268,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.


@@ -142,9 +282,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_FWD_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


@@ -156,7 +296,8 @@ public:
     public:
         // ctors
         MessageParameters() { }
     public:
         // ctors
         MessageParameters() { }

-        MessageParameters(const wxString& filename, const wxString& mimetype)
+        MessageParameters(const wxString& filename,
+                          const wxString& mimetype = wxEmptyString)

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


@@ -188,12 +329,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;
 


@@ -201,6 +340,9 @@ public:
         // get the command to execute the file of given type
     bool GetOpenCommand(wxString *openCmd,
                         const MessageParameters& params) const;
         // get the command to execute the file of given type
     bool GetOpenCommand(wxString *openCmd,
                         const MessageParameters& params) const;

+        // a simpler to use version of GetOpenCommand() -- it only takes the
+        // filename and returns an empty string on failure
+    wxString GetOpenCommand(const wxString& filename) const;

         // get the command to print the file of given type
     bool GetPrintCommand(wxString *printCmd,
                          const MessageParameters& params) const;
         // get the command to print the file of given type
     bool GetPrintCommand(wxString *printCmd,
                          const MessageParameters& params) const;


@@ -210,6 +352,14 @@ public:
     size_t GetAllCommands(wxArrayString *verbs, wxArrayString *commands,
                           const wxFileType::MessageParameters& params) const;
 
     size_t GetAllCommands(wxArrayString *verbs, wxArrayString *commands,
                           const wxFileType::MessageParameters& params) const;
 

+    // set an arbitrary command, ask confirmation if it already exists and
+    // overwriteprompt is true
+    bool SetCommand(const wxString& cmd, const wxString& verb,
+        bool overwriteprompt = true);
+
+    bool SetDefaultIcon(const wxString& cmd = wxEmptyString, int index = 0);
+
+

     // remove the association for this filetype from the system MIME database:
     // notice that it will only work if the association is defined in the user
     // file/registry part, we will never modify the system-wide settings
     // remove the association for this filetype from the system MIME database:
     // notice that it will only work if the association is defined in the user
     // file/registry part, we will never modify the system-wide settings


@@ -242,6 +392,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.
 //


@@ -250,7 +419,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


@@ -259,12 +428,26 @@ 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
     wxMimeTypesManager();
 
     static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
 
     // ctor
     wxMimeTypesManager();
 

+    // NB: the following 2 functions are for Unix only and don't do anything
+    //     elsewhere
+
+    // loads data from standard files according to the mailcap styles
+    // specified: this is a bitwise OR of wxMailcapStyle values
+    //
+    // use the extraDir parameter if you want to look for files in another
+    // directory
+    void Initialize(int mailcapStyle = wxMAILCAP_ALL,
+                    const wxString& extraDir = wxEmptyString);
+
+    // and this function clears all the data from the manager
+    void ClearData();
+

     // Database lookup: all functions return a pointer to wxFileType object
     // whose methods may be used to query it for the information you're
     // interested in. If the return value is !NULL, caller is responsible for
     // Database lookup: all functions return a pointer to wxFileType object
     // whose methods may be used to query it for the information you're
     // interested in. If the return value is !NULL, caller is responsible for


@@ -274,16 +457,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)
         //
         // 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
-    bool ReadMailcap(const wxString& filename, bool fallback = FALSE);
+        // fallback == true this won't happen
+
+    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);
 


@@ -294,7 +481,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


@@ -306,10 +493,11 @@ public:
 
         // create a new association using the fields of wxFileTypeInfo (at least
         // the MIME type and the extension should be set)
 
         // create a new association using the fields of wxFileTypeInfo (at least
         // the MIME type and the extension should be set)

+        // if the other fields are empty, the existing values should be left alone

     wxFileType *Associate(const wxFileTypeInfo& ftInfo);
 
         // undo Associate()
     wxFileType *Associate(const wxFileTypeInfo& ftInfo);
 
         // undo Associate()

-    bool Unassociate(wxFileType *ft) { return ft->Unassociate(); }
+    bool Unassociate(wxFileType *ft) ;

 
     // dtor (not virtual, shouldn't be derived from)
     ~wxMimeTypesManager();
 
     // dtor (not virtual, shouldn't be derived from)
     ~wxMimeTypesManager();


@@ -337,10 +525,10 @@ 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
   //_WX_MIMETYPE_H_
 
 #endif
   //_WX_MIMETYPE_H_

-
-/* vi: set cin tw=80 ts=4 sw=4: */