Add RunScript and implement on all backends. Document and add a very simple unit...

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

diff --git a/include/wx/mimetype.h b/include/wx/mimetype.h
index 7c3fff5c463262bdd9a8bf47dc55e4fb0e38ca85..0bffcb0fee8f269d64ba331a607b2e533f9d1551 100644 (file)
--- a/include/wx/mimetype.h
+++ b/include/wx/mimetype.h
@@ -29,9 +29,9 @@
 #include <stdarg.h>
 
 // fwd decls
 #include <stdarg.h>
 
 // fwd decls

-class WXDLLIMPEXP_BASE wxIconLocation;
-class WXDLLIMPEXP_BASE wxFileTypeImpl;
-class WXDLLIMPEXP_BASE 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()
 
 // these constants define the MIME informations source under UNIX and are used
 // by wxMimeTypesManager::Initialize()


@@ -53,12 +53,12 @@ class WXDLLIMPEXP_BASE wxMimeType : public wxString
 public:
     // all string ctors here
 
 public:
     // all string ctors here
 

-    wxString GetType() const { return BeforeFirst(_T('/')); }
-    wxString GetSubType() const { return AfterFirst(_T('/')); }
+    wxString GetType() const { return BeforeFirst(wxT('/')); }
+    wxString GetSubType() const { return AfterFirst(wxT('/')); }

 
     void SetSubType(const wxString& subtype)
     {
 
     void SetSubType(const wxString& subtype)
     {

-        *this = GetType() + _T('/') + subtype;
+        *this = GetType() + wxT('/') + subtype;

     }
 
     bool Matches(const wxMimeType& wildcard)
     }
 
     bool Matches(const wxMimeType& wildcard)


@@ -125,53 +125,99 @@ private:
                       const wxString& desc,
                       va_list argptr);
 
                       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
+    void VarArgInit(const wxString *mimeType,
+                    const wxString *openCmd,
+                    const wxString *printCmd,
+                    const wxString *desc,
+                    // the other parameters form a NULL terminated list of
+                    // extensions
+                    ...);
+

 public:
 public:

+    // NB: This is a helper to get implicit conversion of variadic ctor's
+    //     fixed arguments into something that can be passed to VarArgInit().
+    //     Do not use, it's used by the ctor only.
+    struct CtorString
+    {
+        CtorString(const char *str) : m_str(str) {}
+        CtorString(const wchar_t *str) : m_str(str) {}
+        CtorString(const wxString& str) : m_str(str) {}
+        CtorString(const wxCStrData& str) : m_str(str) {}
+        CtorString(const wxScopedCharBuffer& str) : m_str(str) {}
+        CtorString(const wxScopedWCharBuffer& str) : m_str(str) {}
+
+        operator const wxString*() const { return &m_str; }
+
+        wxString m_str;
+    };
+

     // ctors
     // ctors

-        // a normal item

 
 

+    // Ctor specifying just the MIME type (which is mandatory), the other
+    // fields can be set later if needed.
+    wxFileTypeInfo(const wxString& mimeType)
+        : m_mimeType(mimeType)
+    {
+    }
+
+    // Ctor allowing to specify the values of all fields at once:
+    //

     // wxFileTypeInfo(const wxString& mimeType,
     //               const wxString& openCmd,
     //               const wxString& printCmd,
     //               const wxString& desc,
     // wxFileTypeInfo(const wxString& mimeType,
     //               const wxString& openCmd,
     //               const wxString& printCmd,
     //               const wxString& desc,

-    //               // the other parameters form a NULL terminated list of
-    //               // extensions
+    //               // 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,
     //               ...);
     WX_DEFINE_VARARG_FUNC_CTOR(wxFileTypeInfo,

-                               4, (const wxString&, const wxString&,
-                                   const wxString&, const wxString&),
-                               VarArgInitWchar, VarArgInitUtf8)
+                               4, (const CtorString&,
+                                   const CtorString&,
+                                   const CtorString&,
+                                   const CtorString&),
+                               VarArgInit, VarArgInit)

 #ifdef __WATCOMC__
     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
 #ifdef __WATCOMC__
     // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351

-    WX_DEFINE_VARARG_FUNC_CTOR(wxFileTypeInfo,
-                               4, (const char*, const char*,
-                                   const char*, const char*),
-                               VarArgInitWchar, VarArgInitUtf8)
-    WX_DEFINE_VARARG_FUNC_CTOR(wxFileTypeInfo,
-                               4, (const wchar_t*, const wchar_t*,
-                                   const wchar_t*, const wchar_t*),
-                               VarArgInitWchar, VarArgInitUtf8)
-    WX_DEFINE_VARARG_FUNC_CTOR(wxFileTypeInfo,
-                               4, (const wxCStrData&, const wxCStrData&,
-                                   const wxCStrData&, const wxCStrData&),
-                               VarArgInitWchar, VarArgInitUtf8)
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const wxString&,
+                                    const wxString&,
+                                    const wxString&,
+                                    const wxString&),
+                                (CtorString(f1),
+                                 CtorString(f2),
+                                 CtorString(f3),
+                                 CtorString(f4)));
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const wxCStrData&,
+                                    const wxCStrData&,
+                                    const wxCStrData&,
+                                    const wxCStrData&),
+                                (CtorString(f1),
+                                 CtorString(f2),
+                                 CtorString(f3),
+                                 CtorString(f4)));
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const char*,
+                                    const char*,
+                                    const char*,
+                                    const char*),
+                                (CtorString(f1),
+                                 CtorString(f2),
+                                 CtorString(f3),
+                                 CtorString(f4)));
+    WX_VARARG_WATCOM_WORKAROUND_CTOR(
+                                wxFileTypeInfo,
+                                4, (const wchar_t*,
+                                    const wchar_t*,
+                                    const wchar_t*,
+                                    const wchar_t*),
+                                (CtorString(f1),
+                                 CtorString(f2),
+                                 CtorString(f3),
+                                 CtorString(f4)));

 #endif
 
         // the array elements correspond to the parameters of the ctor above in
 #endif
 
         // the array elements correspond to the parameters of the ctor above in


@@ -186,6 +232,16 @@ public:
     bool IsValid() const { return !m_mimeType.empty(); }
 
     // setters
     bool IsValid() const { return !m_mimeType.empty(); }
 
     // setters

+        // set the open/print commands
+    void SetOpenCommand(const wxString& command) { m_openCmd = command; }
+    void SetPrintCommand(const wxString& command) { m_printCmd = command; }
+
+        // set the description
+    void SetDescription(const wxString& desc) { m_desc = desc; }
+
+        // add another extension corresponding to this file type
+    void AddExtension(const wxString& ext) { m_exts.push_back(ext); }
+

         // set the icon info
     void SetIcon(const wxString& iconFile, int iconIndex = 0)
     {
         // set the icon info
     void SetIcon(const wxString& iconFile, int iconIndex = 0)
     {


@@ -250,7 +306,7 @@ WX_DECLARE_USER_EXPORTED_OBJARRAY(wxFileTypeInfo, wxArrayFileTypeInfo,
 
 class WXDLLIMPEXP_BASE wxFileType
 {
 
 class WXDLLIMPEXP_BASE wxFileType
 {

-friend class WXDLLIMPEXP_BASE 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


@@ -333,7 +389,7 @@ public:
 
     // operations
         // expand a string in the format of GetOpenCommand (which may contain
 
     // operations
         // expand a string in the format of GetOpenCommand (which may contain

-        // '%s' and '%t' format specificators for the file name and mime type
+        // '%s' and '%t' format specifiers for the file name and mime type

         // and %{param} constructions).
     static wxString ExpandCommand(const wxString& command,
                                   const MessageParameters& params);
         // and %{param} constructions).
     static wxString ExpandCommand(const wxString& command,
                                   const MessageParameters& params);


@@ -372,7 +428,7 @@ public:
 
     static void Set( wxMimeTypesManagerFactory *factory );
     static wxMimeTypesManagerFactory *Get();
 
     static void Set( wxMimeTypesManagerFactory *factory );
     static wxMimeTypesManagerFactory *Get();

-    
+

 private:
     static wxMimeTypesManagerFactory *m_factory;
 };
 private:
     static wxMimeTypesManagerFactory *m_factory;
 };


@@ -423,32 +479,13 @@ 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 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)
-        //
-        // '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
-        // 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);
-

     // enumerate all known MIME types
     //
     // returns the number of retrieved file types
     size_t EnumAllFileTypes(wxArrayString& mimetypes);
 
     // these functions can be used to provide default values for some of the
     // enumerate all known MIME types
     //
     // returns the number of retrieved file types
     size_t EnumAllFileTypes(wxArrayString& mimetypes);
 
     // 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
-    // achieve the same goal, but this requires having this info in a file).
+    // MIME types inside the program itself

     //
     // The filetypes array should be terminated by either NULL entry or an
     // invalid wxFileTypeInfo (i.e. the one created with default ctor)
     //
     // The filetypes array should be terminated by either NULL entry or an
     // invalid wxFileTypeInfo (i.e. the one created with default ctor)