/////////////////////////////////////////////////////////////////////////////
-// Name: common/mimecmn.cpp
+// Name: src/common/mimecmn.cpp
// Purpose: classes and functions to manage MIME types
// Author: Vadim Zeitlin
// Modified by:
// 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)
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "mimetypebase.h"
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
// for compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
-#include "wx/module.h"
#ifdef __BORLANDC__
- #pragma hdrstop
+ #pragma hdrstop
#endif
-#ifndef WX_PRECOMP
- #include "wx/defs.h"
-#endif
+#if wxUSE_MIMETYPE
-#if (wxUSE_FILE && wxUSE_TEXTFILE) || defined(__WXMSW__)
+#include "wx/mimetype.h"
#ifndef WX_PRECOMP
- #include "wx/string.h"
- #if wxUSE_GUI
- #include "wx/icon.h"
- #endif
+ #include "wx/dynarray.h"
+ #include "wx/string.h"
+ #include "wx/intl.h"
+ #include "wx/log.h"
+ #include "wx/module.h"
+ #include "wx/crt.h"
#endif //WX_PRECOMP
-// Doesn't compile in WIN16 mode
-#ifndef __WIN16__
-
-#include "wx/log.h"
#include "wx/file.h"
-#include "wx/intl.h"
-#include "wx/dynarray.h"
+#include "wx/iconloc.h"
#include "wx/confbase.h"
-#ifdef __WXMSW__
- #include "wx/msw/registry.h"
- #include "windows.h"
-#elif defined(__UNIX__) || defined(__WXPM__)
- #include "wx/ffile.h"
- #include "wx/textfile.h"
- #include "wx/dir.h"
- #include "wx/utils.h"
- #include "wx/tokenzr.h"
-#endif // OS
-
-#include "wx/mimetype.h"
-
// other standard headers
#include <ctype.h>
-// in case we're compiling in non-GUI mode
-class WXDLLEXPORT wxIcon;
-
-
// implementation classes:
-
#if defined(__WXMSW__)
#include "wx/msw/mimetype.h"
-#elif defined (__WXMAC__)
+#elif defined(__WXMAC__)
#include "wx/mac/mimetype.h"
-#elif defined (__WXPM__)
+#elif defined(__WXPM__) || defined (__EMX__)
#include "wx/os2/mimetype.h"
+ #undef __UNIX__
+#elif defined(__DOS__)
+ #include "wx/msdos/mimetype.h"
#else // Unix
#include "wx/unix/mimetype.h"
#endif
// common classes
// ============================================================================
+// ----------------------------------------------------------------------------
+// wxMimeTypeCommands
+// ----------------------------------------------------------------------------
+
+void
+wxMimeTypeCommands::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;
+ }
+}
+
+wxString
+wxMimeTypeCommands::GetCommandForVerb(const wxString& verb, size_t *idx) 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;
+}
+
+wxString wxMimeTypeCommands::GetVerbCmd(size_t n) const
+{
+ return m_verbs[n] + wxT('=') + m_commands[n];
+}
+
// ----------------------------------------------------------------------------
// wxFileTypeInfo
// ----------------------------------------------------------------------------
-wxFileTypeInfo::wxFileTypeInfo(const char *mimeType,
- const char *openCmd,
- const char *printCmd,
- const char *desc,
- ...)
- : m_mimeType(mimeType),
- m_openCmd(openCmd),
- m_printCmd(printCmd),
- m_desc(desc)
+void wxFileTypeInfo::DoVarArgInit(const wxString& mimeType,
+ const wxString& openCmd,
+ const wxString& printCmd,
+ const wxString& desc,
+ va_list argptr)
{
- va_list argptr;
- va_start(argptr, desc);
+ m_mimeType = mimeType;
+ m_openCmd = openCmd;
+ m_printCmd = printCmd;
+ m_desc = desc;
for ( ;; )
{
- const char *ext = va_arg(argptr, const char *);
+ // icc gives this warning in its own va_arg() macro, argh
+#ifdef __INTELC__
+ #pragma warning(push)
+ #pragma warning(disable: 1684)
+#endif
+
+ wxArgNormalizedString ext(WX_VA_ARG_STRING(argptr));
+
+#ifdef __INTELC__
+ #pragma warning(pop)
+#endif
if ( !ext )
{
// NULL terminates the list
break;
}
- m_exts.Add(ext);
+ m_exts.Add(ext.GetString());
}
+}
+
+void wxFileTypeInfo::VarArgInit(const wxString *mimeType,
+ const wxString *openCmd,
+ const wxString *printCmd,
+ const wxString *desc,
+ ...)
+{
+ va_list argptr;
+ va_start(argptr, desc);
+
+ DoVarArgInit(*mimeType, *openCmd, *printCmd, *desc, argptr);
va_end(argptr);
}
-#include "wx/arrimpl.cpp"
-WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo);
+wxFileTypeInfo::wxFileTypeInfo(const wxArrayString& sArray)
+{
+ m_mimeType = sArray [0u];
+ m_openCmd = sArray [1u];
+ m_printCmd = sArray [2u];
+ m_desc = sArray [3u];
+
+ size_t count = sArray.GetCount();
+ for ( size_t i = 4; i < count; i++ )
+ {
+ m_exts.Add(sArray[i]);
+ }
+}
+
+#include "wx/arrimpl.cpp"
+WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo)
// ============================================================================
// implementation of the wrapper classes
// wxFileType
// ----------------------------------------------------------------------------
+/* static */
wxString wxFileType::ExpandCommand(const wxString& command,
const wxFileType::MessageParameters& params)
{
- bool hasFilename = FALSE;
+ bool hasFilename = false;
wxString str;
for ( const wxChar *pc = command.c_str(); *pc != wxT('\0'); pc++ ) {
str << wxT('"') << params.GetFileName() << wxT('"');
#endif
str << params.GetFileName();
- hasFilename = TRUE;
+ hasFilename = true;
break;
case wxT('t'):
// behave like this, in particular a common test is 'test -n "$DISPLAY"'
// and appending "< %s" to this command makes the test fail... I don't
// know of the correct solution, try to guess what we have to do.
- if ( !hasFilename && !str.IsEmpty()
+
+ // test now carried out on reading file so test should never get here
+ if ( !hasFilename && !str.empty()
#ifdef __UNIX__
&& !str.StartsWith(_T("test "))
#endif // Unix
return str;
}
+wxFileType::wxFileType(const wxFileTypeInfo& info)
+{
+ m_info = &info;
+ m_impl = NULL;
+}
+
wxFileType::wxFileType()
{
+ m_info = NULL;
m_impl = new wxFileTypeImpl;
}
wxFileType::~wxFileType()
{
- delete m_impl;
+ if ( m_impl )
+ delete m_impl;
}
bool wxFileType::GetExtensions(wxArrayString& extensions)
{
+ if ( m_info )
+ {
+ extensions = m_info->GetExtensions();
+ return true;
+ }
+
return m_impl->GetExtensions(extensions);
}
bool wxFileType::GetMimeType(wxString *mimeType) const
{
+ wxCHECK_MSG( mimeType, false, _T("invalid parameter in GetMimeType") );
+
+ if ( m_info )
+ {
+ *mimeType = m_info->GetMimeType();
+
+ return true;
+ }
+
return m_impl->GetMimeType(mimeType);
}
bool wxFileType::GetMimeTypes(wxArrayString& mimeTypes) const
{
+ if ( m_info )
+ {
+ mimeTypes.Clear();
+ mimeTypes.Add(m_info->GetMimeType());
+
+ return true;
+ }
+
return m_impl->GetMimeTypes(mimeTypes);
}
-bool wxFileType::GetIcon(wxIcon *icon,
- wxString *iconFile,
- int *iconIndex) const
+bool wxFileType::GetIcon(wxIconLocation *iconLoc) const
{
+ if ( m_info )
+ {
+ if ( iconLoc )
+ {
+ iconLoc->SetFileName(m_info->GetIconFile());
#ifdef __WXMSW__
- return m_impl->GetIcon(icon, iconFile, iconIndex);
-#else
- return m_impl->GetIcon(icon);
-#endif
+ iconLoc->SetIndex(m_info->GetIconIndex());
+#endif // __WXMSW__
+ }
+
+ return true;
+ }
+
+ return m_impl->GetIcon(iconLoc);
+}
+
+bool
+wxFileType::GetIcon(wxIconLocation *iconloc,
+ const MessageParameters& params) const
+{
+ if ( !GetIcon(iconloc) )
+ {
+ return false;
+ }
+
+ // we may have "%s" in the icon location string, at least under Windows, so
+ // expand this
+ if ( iconloc )
+ {
+ iconloc->SetFileName(ExpandCommand(iconloc->GetFileName(), params));
+ }
+
+ return true;
}
bool wxFileType::GetDescription(wxString *desc) const
{
+ wxCHECK_MSG( desc, false, _T("invalid parameter in GetDescription") );
+
+ if ( m_info )
+ {
+ *desc = m_info->GetDescription();
+
+ return true;
+ }
+
return m_impl->GetDescription(desc);
}
wxFileType::GetOpenCommand(wxString *openCmd,
const wxFileType::MessageParameters& params) const
{
+ wxCHECK_MSG( openCmd, false, _T("invalid parameter in GetOpenCommand") );
+
+ if ( m_info )
+ {
+ *openCmd = ExpandCommand(m_info->GetOpenCommand(), params);
+
+ return true;
+ }
+
return m_impl->GetOpenCommand(openCmd, params);
}
+wxString wxFileType::GetOpenCommand(const wxString& filename) const
+{
+ wxString cmd;
+ if ( !GetOpenCommand(&cmd, filename) )
+ {
+ // return empty string to indicate an error
+ cmd.clear();
+ }
+
+ return cmd;
+}
+
bool
wxFileType::GetPrintCommand(wxString *printCmd,
const wxFileType::MessageParameters& params) const
{
+ wxCHECK_MSG( printCmd, false, _T("invalid parameter in GetPrintCommand") );
+
+ if ( m_info )
+ {
+ *printCmd = ExpandCommand(m_info->GetPrintCommand(), params);
+
+ return true;
+ }
+
return m_impl->GetPrintCommand(printCmd, params);
}
if ( commands )
commands->Clear();
-#ifdef __WXMSW__
+#if defined (__WXMSW__) || defined(__UNIX__)
return m_impl->GetAllCommands(verbs, commands, params);
-#else // !__WXMSW__
+#else // !__WXMSW__ || Unix
// we don't know how to retrieve all commands, so just try the 2 we know
// about
size_t count = 0;
wxString cmd;
- if ( m_impl->GetOpenCommand(&cmd, params) )
+ if ( GetOpenCommand(&cmd, params) )
{
if ( verbs )
verbs->Add(_T("Open"));
}
return count;
-#endif // __WXMSW__/!__WXMSW__
-}
-
-bool wxFileType::SetOpenCommand(const wxString& cmd, bool overwriteprompt)
-{
- return SetCommand(cmd, _T("open"), overwriteprompt);
+#endif // __WXMSW__/| __UNIX__
}
-bool wxFileType::SetCommand(const wxString& cmd, const wxString& verb,
- bool overwriteprompt)
+bool wxFileType::Unassociate()
{
-#ifdef __WXMSW__
- return m_impl->SetCommand(cmd, verb, overwriteprompt);
+#if defined(__WXMSW__)
+ return m_impl->Unassociate();
+#elif defined(__UNIX__)
+ return m_impl->Unassociate(this);
#else
- wxFAIL_MSG(_T("not implemented"));
-
- return FALSE;
+ wxFAIL_MSG( _T("not implemented") ); // TODO
+ return false;
#endif
}
-bool wxFileType::SetMimeType(const wxString& mimeType)
+bool wxFileType::SetCommand(const wxString& cmd,
+ const wxString& verb,
+ bool overwriteprompt)
{
- // empty MIME type is meaningless here
- wxCHECK_MSG( !mimeType.empty(), FALSE, _T("use RemoveMimeType()") );
-
-#ifdef __WXMSW__
- return m_impl->SetMimeType(mimeType);
+#if defined (__WXMSW__) || defined(__UNIX__)
+ return m_impl->SetCommand(cmd, verb, overwriteprompt);
#else
+ wxUnusedVar(cmd);
+ wxUnusedVar(verb);
+ wxUnusedVar(overwriteprompt);
wxFAIL_MSG(_T("not implemented"));
-
- return FALSE;
+ return false;
#endif
}
bool wxFileType::SetDefaultIcon(const wxString& cmd, int index)
{
wxString sTmp = cmd;
+#ifdef __WXMSW__
// VZ: should we do this?
+ // chris elliott : only makes sense in MS windows
if ( sTmp.empty() )
- GetOpenCommand(&sTmp, wxFileType::MessageParameters("", ""));
-
+ GetOpenCommand(&sTmp, wxFileType::MessageParameters(wxEmptyString, wxEmptyString));
+#endif
wxCHECK_MSG( !sTmp.empty(), false, _T("need the icon file") );
-
-#ifdef __WXMSW__
+#if defined (__WXMSW__) || defined(__UNIX__)
return m_impl->SetDefaultIcon (cmd, index);
#else
+ wxUnusedVar(index);
wxFAIL_MSG(_T("not implemented"));
-
- return FALSE;
+ return false;
#endif
}
-// now do remove functions
-bool wxFileType::RemoveOpenCommand()
-{
- return RemoveCommand(_T("open"));
-}
-
-bool wxFileType::RemoveCommand(const wxString& verb)
-{
-#ifdef __WXMSW__
- return m_impl->RemoveCommand(verb);
-#else
- wxFAIL_MSG(_T("not implemented"));
+// ----------------------------------------------------------------------------
+// wxMimeTypesManagerFactory
+// ----------------------------------------------------------------------------
- return FALSE;
-#endif
-}
+wxMimeTypesManagerFactory *wxMimeTypesManagerFactory::m_factory = NULL;
-bool wxFileType::RemoveMimeType()
+/* static */
+void wxMimeTypesManagerFactory::Set(wxMimeTypesManagerFactory *factory)
{
-#ifdef __WXMSW__
- return m_impl->RemoveMimeType ();
-#else
- wxFAIL_MSG(_T("not implemented"));
+ delete m_factory;
- return FALSE;
-#endif
+ m_factory = factory;
}
-bool wxFileType::RemoveDefaultIcon()
+/* static */
+wxMimeTypesManagerFactory *wxMimeTypesManagerFactory::Get()
{
-#ifdef __WXMSW__
- return m_impl->RemoveDefaultIcon();
-#else
- wxFAIL_MSG(_T("not implemented"));
+ if ( !m_factory )
+ m_factory = new wxMimeTypesManagerFactory;
- return FALSE;
-#endif
+ return m_factory;
}
-bool wxFileType::Unassociate()
+wxMimeTypesManagerImpl *wxMimeTypesManagerFactory::CreateMimeTypesManagerImpl()
{
- bool result = TRUE;
- if ( !RemoveOpenCommand() )
- result = FALSE;
- if ( !RemoveDefaultIcon() )
- result = FALSE;
- if ( !RemoveMimeType() )
- result = FALSE;
-
- // in MSW this leaves a HKCR.xzy key
- return result;
+ return new wxMimeTypesManagerImpl;
}
// ----------------------------------------------------------------------------
void wxMimeTypesManager::EnsureImpl()
{
if ( !m_impl )
- m_impl = new wxMimeTypesManagerImpl;
+ m_impl = wxMimeTypesManagerFactory::Get()->CreateMimeTypesManagerImpl();
}
bool wxMimeTypesManager::IsOfType(const wxString& mimeType,
wxASSERT_MSG( mimeType.Find(wxT('*')) == wxNOT_FOUND,
wxT("first MIME type can't contain wildcards") );
- // all comparaisons are case insensitive (2nd arg of IsSameAs() is FALSE)
- if ( wildcard.BeforeFirst(wxT('/')).IsSameAs(mimeType.BeforeFirst(wxT('/')), FALSE) )
+ // all comparaisons are case insensitive (2nd arg of IsSameAs() is false)
+ if ( wildcard.BeforeFirst(wxT('/')).
+ IsSameAs(mimeType.BeforeFirst(wxT('/')), false) )
{
wxString strSubtype = wildcard.AfterFirst(wxT('/'));
if ( strSubtype == wxT("*") ||
- strSubtype.IsSameAs(mimeType.AfterFirst(wxT('/')), FALSE) )
+ strSubtype.IsSameAs(mimeType.AfterFirst(wxT('/')), false) )
{
// matches (either exactly or it's a wildcard)
- return TRUE;
+ return true;
}
}
- return FALSE;
+ return false;
}
wxMimeTypesManager::wxMimeTypesManager()
wxMimeTypesManager::~wxMimeTypesManager()
{
- delete m_impl;
+ if ( m_impl )
+ delete m_impl;
}
+bool wxMimeTypesManager::Unassociate(wxFileType *ft)
+{
+ EnsureImpl();
+
+#if defined(__UNIX__) && !defined(__CYGWIN__) && !defined(__WINE__)
+ return m_impl->Unassociate(ft);
+#else
+ return ft->Unassociate();
+#endif
+}
+
+
wxFileType *
-wxMimeTypesManager::GetFileTypeFromExtension(const wxString& ext)
+wxMimeTypesManager::Associate(const wxFileTypeInfo& ftInfo)
{
EnsureImpl();
- return m_impl->GetFileTypeFromExtension(ext);
+
+#if defined(__WXMSW__) || defined(__UNIX__)
+ return m_impl->Associate(ftInfo);
+#else // other platforms
+ wxUnusedVar(ftInfo);
+ wxFAIL_MSG( _T("not implemented") ); // TODO
+ return NULL;
+#endif // platforms
}
wxFileType *
-wxMimeTypesManager::GetOrAllocateFileTypeFromExtension(const wxString& ext)
+wxMimeTypesManager::GetFileTypeFromExtension(const wxString& ext)
{
EnsureImpl();
-#ifdef __WXMSW__
- // this writes a root entry to the registry in HKCR.ext
- return m_impl->GetOrAllocateFileTypeFromExtension(ext);
-#else // !__WXMSW__
- // VZ: "static const"??? (FIXME)
- // just make a dummy entry with no writing to file
- static const wxFileTypeInfo fallback[] =
- {
- wxFileTypeInfo("application/x-" + ext,
- "",
- "",
- ext + " format file",
- ext, NULL),
- // must terminate the table with this!
- wxFileTypeInfo()
- };
+ wxString::const_iterator i = ext.begin();
+ const wxString::const_iterator end = ext.end();
+ wxString extWithoutDot;
+ if ( i != end && *i == '.' )
+ extWithoutDot.assign(++i, ext.end());
+ else
+ extWithoutDot = ext;
+
+ wxCHECK_MSG( !ext.empty(), NULL, _T("extension can't be empty") );
+
+ wxFileType *ft = m_impl->GetFileTypeFromExtension(extWithoutDot);
+
+ if ( !ft ) {
+ // check the fallbacks
+ //
+ // TODO linear search is potentially slow, perhaps we should use a
+ // sorted array?
+ size_t count = m_fallbacks.GetCount();
+ for ( size_t n = 0; n < count; n++ ) {
+ if ( m_fallbacks[n].GetExtensions().Index(ext) != wxNOT_FOUND ) {
+ ft = new wxFileType(m_fallbacks[n]);
+
+ break;
+ }
+ }
+ }
- AddFallbacks (fallback);
- return m_impl->GetFileTypeFromExtension(ext);
-#endif // __WXMSW__/!__WXMSW__
+ return ft;
}
-
wxFileType *
wxMimeTypesManager::GetFileTypeFromMimeType(const wxString& mimeType)
{
EnsureImpl();
- return m_impl->GetFileTypeFromMimeType(mimeType);
+ wxFileType *ft = m_impl->GetFileTypeFromMimeType(mimeType);
+
+ if ( !ft ) {
+ // check the fallbacks
+ //
+ // TODO linear search is potentially slow, perhaps we should use a
+ // sorted array?
+ size_t count = m_fallbacks.GetCount();
+ for ( size_t n = 0; n < count; n++ ) {
+ if ( wxMimeTypesManager::IsOfType(mimeType,
+ m_fallbacks[n].GetMimeType()) ) {
+ ft = new wxFileType(m_fallbacks[n]);
+
+ break;
+ }
+ }
+ }
+
+ return ft;
}
bool wxMimeTypesManager::ReadMailcap(const wxString& filename, bool fallback)
void wxMimeTypesManager::AddFallbacks(const wxFileTypeInfo *filetypes)
{
EnsureImpl();
- for ( const wxFileTypeInfo *ft = filetypes; ft->IsValid(); ft++ ) {
- m_impl->AddFallback(*ft);
+ for ( const wxFileTypeInfo *ft = filetypes; ft && ft->IsValid(); ft++ ) {
+ AddFallback(*ft);
}
}
size_t wxMimeTypesManager::EnumAllFileTypes(wxArrayString& mimetypes)
{
EnsureImpl();
- return m_impl->EnumAllFileTypes(mimetypes);
+ size_t countAll = m_impl->EnumAllFileTypes(mimetypes);
+
+ // add the fallback filetypes
+ size_t count = m_fallbacks.GetCount();
+ for ( size_t n = 0; n < count; n++ ) {
+ if ( mimetypes.Index(m_fallbacks[n].GetMimeType()) == wxNOT_FOUND ) {
+ mimetypes.Add(m_fallbacks[n].GetMimeType());
+ countAll++;
+ }
+ }
+
+ return countAll;
}
+void wxMimeTypesManager::Initialize(int mcapStyle,
+ const wxString& sExtraDir)
+{
+#if defined(__UNIX__) && !defined(__CYGWIN__) && !defined(__WINE__)
+ EnsureImpl();
+
+ m_impl->Initialize(mcapStyle, sExtraDir);
+#else
+ (void)mcapStyle;
+ (void)sExtraDir;
+#endif // Unix
+}
+
+// and this function clears all the data from the manager
+void wxMimeTypesManager::ClearData()
+{
+#if defined(__UNIX__) && !defined(__CYGWIN__) && !defined(__WINE__)
+ EnsureImpl();
+
+ m_impl->ClearData();
+#endif // Unix
+}
// ----------------------------------------------------------------------------
-// global data
+// global data and wxMimeTypeCmnModule
// ----------------------------------------------------------------------------
// private object
static wxMimeTypesManager gs_mimeTypesManager;
// and public pointer
-wxMimeTypesManager * wxTheMimeTypesManager = &gs_mimeTypesManager;
+wxMimeTypesManager *wxTheMimeTypesManager = &gs_mimeTypesManager;
class wxMimeTypeCmnModule: public wxModule
{
public:
wxMimeTypeCmnModule() : wxModule() { }
- virtual bool OnInit() { return TRUE; }
+
+ virtual bool OnInit() { return true; }
virtual void OnExit()
{
- // this avoids false memory leak allerts:
+ wxMimeTypesManagerFactory::Set(NULL);
+
if ( gs_mimeTypesManager.m_impl != NULL )
{
delete gs_mimeTypesManager.m_impl;
gs_mimeTypesManager.m_impl = NULL;
+ gs_mimeTypesManager.m_fallbacks.Clear();
}
}
IMPLEMENT_DYNAMIC_CLASS(wxMimeTypeCmnModule, wxModule)
-#endif
- // wxUSE_FILE && wxUSE_TEXTFILE
-
-#endif
- // __WIN16__
+#endif // wxUSE_MIMETYPE
projects / wxWidgets.git / blobdiff