Identifier.h

Go to the documentation of this file.

/**********************************************************************
 
 Audacity: A Digital Audio Editor
 
 Identifier.h
 
 Paul Licameli split from Types.h
 
 **********************************************************************/
 
#ifndef __AUDACITY_IDENTIFIER__
#define __AUDACITY_IDENTIFIER__
 
#include <vector>
#include <wx/string.h>
 
 
class STRINGS_API Identifier
{
public:
 
   Identifier() = default;
 
   Identifier(const wxString &str) : value{ str } {}
 
   Identifier(const wxChar *str) : value{ str } {}
 
   Identifier(const char *str) : value{ str } {}
 
   // Copy construction and assignment
   Identifier( const Identifier & ) = default;
   Identifier &operator = ( const Identifier& ) = default;
 
   // Move construction and assignment
   Identifier( wxString && str )
      { value.swap( str ); }
   Identifier( Identifier && id )
      { swap( id ); }
   Identifier &operator= ( Identifier&& id )
   {
      if ( this != &id )
         value.clear(), swap( id );
      return *this;
   }
 
   // Implements moves
   void swap( Identifier &id ) { value.swap( id.value ); }
 
 
   explicit
   Identifier(std::initializer_list<Identifier> components, wxChar separator);
 
   bool empty() const { return value.empty(); }
   size_t size() const { return value.size(); }
   size_t length() const { return value.length(); }
 
   const wxString &GET() const { return value; }
 
   std::vector< Identifier > split( wxChar separator ) const;
 
private:
   wxString value;
};
 
inline bool operator == ( const Identifier &x, const Identifier &y )
{ return x.GET() == y.GET(); }
 
inline bool operator != ( const Identifier &x, const Identifier &y )
{ return !(x == y); }
 
inline bool operator < ( const Identifier &x, const Identifier &y )
{ return x.GET() < y.GET(); }
 
inline bool operator > ( const Identifier &x, const Identifier &y )
{ return y < x; }
 
inline bool operator <= ( const Identifier &x, const Identifier &y )
{ return !(y < x); }
 
inline bool operator >= ( const Identifier &x, const Identifier &y )
{ return !(x < y); }
 
namespace std
{
   template<> struct hash< Identifier > {
      size_t operator () ( const Identifier &id ) const // noexcept
       { return hash<wxString>{}( id.GET() ); }
   };
}
 
inline bool wxFromString(const wxString& str, Identifier *id)
   { if (id) { *id = str; return true; } else return false; }
 
inline wxString wxToString( const Identifier& str ) { return str.GET(); }
 
 
template<typename Tag, bool CaseSensitive = true >
class TaggedIdentifier : public Identifier
{
public:
 
   using TagType = Tag;
 
   using Identifier::Identifier;
   TaggedIdentifier() = default;
 
   TaggedIdentifier( const TaggedIdentifier& ) = default;
   TaggedIdentifier( TaggedIdentifier&& ) = default;
   TaggedIdentifier& operator= ( const TaggedIdentifier& ) = default;
   TaggedIdentifier& operator= ( TaggedIdentifier&& ) = default;
 
   template< typename Tag2, bool b >
   TaggedIdentifier( const TaggedIdentifier<Tag2, b>& ) = delete;
   template< typename Tag2, bool b >
   TaggedIdentifier( TaggedIdentifier<Tag2, b>&& ) = delete;
   template< typename Tag2, bool b >
   TaggedIdentifier& operator= ( const TaggedIdentifier<Tag2, b>& ) = delete;
   template< typename Tag2, bool b >
   TaggedIdentifier& operator= ( TaggedIdentifier<Tag2, b>&& ) = delete;
 
   TaggedIdentifier(const Identifier &str) : Identifier{ str } {}
 
   template<typename String, typename = typename String::TagType>
      String CONVERT() const
         { return String{ this->GET() }; }
};
 
template< typename Tag1, typename Tag2, bool b1, bool b2 >
inline bool operator == (
   const TaggedIdentifier< Tag1, b1 > &x, const TaggedIdentifier< Tag2, b2 > &y )
{
   static_assert( std::is_same_v< Tag1, Tag2 > && b1 == b2,
      "TaggedIdentifiers with different tags or sensitivity are not comparable" );
   // This test should be eliminated at compile time:
   if ( b1 )
      return x.GET(). Cmp ( y.GET() ) == 0;
   else
      return x.GET(). CmpNoCase ( y.GET() ) == 0;
}
 
template< typename Tag1, typename Tag2, bool b1, bool b2 >
inline bool operator != (
   const TaggedIdentifier< Tag1, b1 > &x, const TaggedIdentifier< Tag2, b2 > &y )
{ return !(x == y); }
 
template< typename Tag1, typename Tag2, bool b1, bool b2 >
inline bool operator < (
   const TaggedIdentifier< Tag1, b1 > &x, const TaggedIdentifier< Tag2, b2 > &y )
{
   static_assert( std::is_same_v< Tag1, Tag2 > && b1 == b2,
      "TaggedIdentifiers with different tags or sensitivity are not comparable" );
   // This test should be eliminated at compile time:
   if ( b1 )
      return x.GET(). Cmp ( y.GET() ) < 0;
   else
      return x.GET(). CmpNoCase ( y.GET() ) < 0;
}
 
template< typename Tag1, typename Tag2, bool b1, bool b2 >
inline bool operator > (
   const TaggedIdentifier< Tag1, b1 > &x, const TaggedIdentifier< Tag2, b2 > &y )
{ return y < x; }
 
template< typename Tag1, typename Tag2, bool b1, bool b2 >
inline bool operator <= (
   const TaggedIdentifier< Tag1, b1 > &x, const TaggedIdentifier< Tag2, b2 > &y )
{ return !(y < x); }
 
template< typename Tag1, typename Tag2, bool b1, bool b2 >
inline bool operator >= (
   const TaggedIdentifier< Tag1, b1 > &x, const TaggedIdentifier< Tag2, b2 > &y )
{ return !(x < y); }
 
namespace std
{
   template<typename Tag, bool b > struct hash< TaggedIdentifier<Tag, b> >
      : hash< Identifier > {};
}
 
/**************************************************************************/
using PluginPath = wxString;
using PluginPaths = std::vector< PluginPath >;
 
// A key to be passed to wxConfigBase
using RegistryPath = wxString;
using RegistryPaths = std::vector< RegistryPath >;
 
class wxArrayStringEx;
 
using FileExtension = wxString;
using FileExtensions = wxArrayStringEx;
 
using FilePath = wxString;
using FilePaths = wxArrayStringEx;
 
struct CommandIdTag;
using CommandID = TaggedIdentifier< CommandIdTag, false >;
using CommandIDs = std::vector<CommandID>;
 
struct ManualPageIDTag;
using ManualPageID = TaggedIdentifier< ManualPageIDTag >;
 
using NumericFormatID = TaggedIdentifier<struct NumericFormatIDTag>;
 
#endif