src/amarok.h

   1 //See COPYING file for licensing information
   2
   3 #ifndef AMAROK_H
   4 #define AMAROK_H
   5
   6 #include <K3ProcIO> //Amarok::ProcIO
   7 #include <KActionCollection>
   8 #include <KConfig>
   9 #include <KIO/NetAccess>
  10 #include <KUrl> // recursiveUrlExpand
  11
  12 #include "amarok_export.h"
  13
  14 class QColor;
  15 class QDateTime;
  16 class QEvent;
  17 class QMutex;
  18 class QPixmap;
  19 class QWidget;
  20 class Q3ListView;
  21 class Q3ListViewItem;
  22 namespace KIO { class Job; }
  23
  24 namespace Amarok
  25 {
  26     const int VOLUME_MAX = 100;
  27     const int SCOPE_SIZE = 9; //= 2**9 = 512
  28     const int blue       = 0x202050;
  29     const int VOLUME_SENSITIVITY = 30; //for mouse wheels
  30     const int GUI_THREAD_ID = 0;
  31
  32     extern QMutex globalDirsMutex; // defined in app.cpp
  33
  34     namespace ColorScheme
  35     {
  36         ///eg. base of the Amarok Player-window
  37         extern QColor Base; //Amarok::blue
  38         ///eg. text in the Amarok Player-window
  39         extern QColor Text; //Qt::white
  40         ///eg. background colour for Amarok::PrettySliders
  41         extern QColor Background; //brighter blue
  42         ///eg. outline of slider widgets in Player-window
  43         extern QColor Foreground; //lighter blue
  44         ///eg. K3ListView alternative row color
  45         extern QColor AltBase; //grey toned base
  46     }
  47
  48     /** The version of the playlist XML format. Increase whenever it changes backwards-incompatibly. */
  49     inline QString xmlVersion() { return "2.4"; }
  50
  51     /**
  52      * Convenience function to return the KApplication instance KConfig object
  53      * pre-set to a specific group.
  54      * @param group Will pre-set the KConfig object to this group.
  55      */
  56     /* FIXME: This function can lead to very bizarre and hard to figure bugs.
  57               While we don`t fix it properly, use it like this: amarok::config( Group )->readEntry( ... ) */
  58     AMAROK_EXPORT KConfigGroup config( const QString &group = "General" ); //defined in app.cpp
  59
  60     /**
  61      * @return the KActionCollection used by Amarok
  62      * The KActionCollection is owned by the PlaylistWindow, so you must ensure
  63      * you don't try to use this before then, but we've taken steps to prevent
  64      * this eventuality - you should be safe.
  65      */
  66     KActionCollection *actionCollection(); //defined in app.cpp
  67
  68     /**
  69      * Invoke the external web browser set in Amarok's configuration.
  70      * @param url The URL to be opened in the browser.
  71      * @return True if the browser could be started.
  72      */
  73     bool invokeBrowser( const QString& url ); //defined in app.cpp
  74
  75     /**
  76      * The mainWindow is the playlistWindow
  77      */
  78     AMAROK_EXPORT QWidget *mainWindow(); //defined in app.cpp
  79
  80     /**
  81      * Allocate one on the stack, and it'll set the busy cursor for you until it
  82      * is destroyed
  83      */
  84     class OverrideCursor { //defined in app.cpp
  85     public:
  86         OverrideCursor( Qt::CursorShape cursor = Qt::WaitCursor );
  87        ~OverrideCursor();
  88     };
  89
  90     /**
  91      * For saving files to ~/.kde/share/apps/amarok/directory
  92      * @param directory will be created if not existing, you MUST end the string
  93      *                  with '/'
  94      */
  95     AMAROK_EXPORT QString saveLocation( const QString &directory = QString() ); //defined in collectionreader.cpp
  96
  97     KIO::Job *trashFiles( const KUrl::List &files ); //defined in app.cpp
  98
  99     /**
 100      * For recursively expanding the contents of a directory into a KUrl::List
 101      * (playlists are ignored)
 102      */
 103     //PORT 2.0
 104 //     AMAROK_EXPORT KUrl::List recursiveUrlExpand( const KUrl &url, int maxURLs = -1 ); //defined in playlistloader.cpp
 105 //     AMAROK_EXPORT KUrl::List recursiveUrlExpand( const KUrl::List &urls, int maxURLs = -1 ); //defined in playlistloader.cpp
 106
 107     //New in Amarok2 -> recursiveUrlExpand has been replaced
 108     //existing code depending on this port need to be changed (max urls is removed)
 109     AMAROK_EXPORT KUrl::List recursiveUrlExpand( const KUrl &url ); //defined in PlaylistHandler.cpp
 110     AMAROK_EXPORT KUrl::List recursiveUrlExpand( const KUrl::List &urls ); //defined in PlaylistHandler.cpp
 111
 112     AMAROK_EXPORT QString verboseTimeSince( const QDateTime &datetime ); //defined in tracktooltip.cpp
 113
 114     AMAROK_EXPORT QString verboseTimeSince( uint time_t ); //defined in tracktooltip.cpp
 115
 116     /**
 117      * Function that must be used when separating contextBrowser escaped urls
 118      */
 119     // defined in Statistics.cpp
 120     void albumArtistTrackFromUrl( QString url, QString &artist, QString &album, QString &detail );
 121
 122     /**
 123      * @return the LOWERCASE file extension without the preceding '.', or "" if there is none
 124      */
 125     inline QString extension( const QString &fileName )
 126     {
 127         return fileName.contains( '.' ) ? fileName.mid( fileName.lastIndexOf( '.' ) + 1 ).toLower() : "";
 128     }
 129
 130     /** Transform url into a file url if possible */
 131     inline KUrl mostLocalURL( const KUrl &url )
 132     {
 133         return KIO::NetAccess::mostLocalUrl( url, mainWindow() );
 134     }
 135
 136     /**
 137      * @return the last directory in @param fileName
 138      */
 139     inline QString directory( const QString &fileName )
 140     {
 141         return fileName.section( '/', 0, -2 );
 142     }
 143   /** Due to xine-lib, we have to make K3Process close all fds, otherwise we get "device is busy" messages
 144   * Used by Amarok::ProcIO and Amarok::Process, exploiting commSetupDoneC(), a virtual method that
 145   * happens to be called in the forked process
 146   * See bug #103750 for more information.
 147   */
 148   //TODO ugly hack, fix K3Process for KDE 4.0
 149     void closeOpenFiles(int out, int in, int err); //defined in scriptmanager.cpp
 150
 151     /**
 152     * Returns internal code for database type, DbConnection::sqlite, DbConnection::mysql, or DbConnection::postgresql
 153     * @param type either "SQLite", "MySQL", or "Postgresql".
 154     */
 155     int databaseTypeCode( const QString type ); //defined in configdialog.cpp
 156
 157     void setUseScores( bool use ); //defined in app.cpp
 158     void setUseRatings( bool use );
 159     void setMoodbarPrefs( bool show, bool moodier, int alter, bool withMusic );
 160
 161     bool repeatNone(); //defined in actionclasses.cpp
 162     bool repeatTrack();
 163     bool repeatAlbum();
 164     bool repeatPlaylist();
 165     bool randomOff();
 166     bool randomTracks();
 167     bool randomAlbums();
 168     bool favorNone();
 169     bool favorScores();
 170     bool favorRatings();
 171     bool favorLastPlay();
 172     bool entireAlbums(); //repeatAlbum() || randomAlbums()
 173
 174 // Port 2.0: Reenable when we have a new dynamic mode
 175 //     const DynamicMode *dynamicMode(); //defined in playlist.cpp
 176
 177     QStringList splitPath( QString path ); //defined in playlistbrowser.cpp
 178
 179     /**
 180      * Maps the icon name to a system icon or custom Amarok icon, depending on the settings.
 181      */
 182     AMAROK_EXPORT QString icon( const QString& name ); //defined in iconloader.cpp
 183
 184     /**
 185      * Removes accents from the string
 186      * @param path The original path.
 187      * @return The cleaned up path.
 188      */
 189     AMAROK_EXPORT QString cleanPath( const QString &path ); //defined in app.cpp
 190
 191     /**
 192      * Replaces all non-ASCII characters with '_'.
 193      * @param path The original path.
 194      * @return The ASCIIfied path.
 195      */
 196     AMAROK_EXPORT QString asciiPath( const QString &path ); //defined in app.cpp
 197
 198     /**
 199      * Transform path into one valid on VFAT file systems
 200      * @param path The original path.
 201      * @return The cleaned up path.
 202      */
 203     AMAROK_EXPORT QString vfatPath( const QString &path ); //defined in app.cpp
 204
 205     /**
 206      * Compare both strings from left to right and remove the common part from input
 207      * @param input the string that get's cleaned.
 208      * @param ref a reference to compare input with.
 209      * @return The cleaned up string.
 210      */
 211     AMAROK_EXPORT QString decapitateString( const QString &input, const QString &ref );
 212
 213     /*
 214      * Transform to be usable within HTML/HTML attributes
 215      */
 216     AMAROK_EXPORT QString escapeHTMLAttr( const QString &s );
 217     AMAROK_EXPORT QString unescapeHTMLAttr( const QString &s ); //defined in statistics.cpp
 218
 219     /* defined in scriptmanager.cpp */
 220     /**
 221      * Returns the proxy that should be used for a given URL.
 222      * @param url the url.
 223      * @return The url of the proxy, or a empty string if no proxy should be used.
 224      */
 225     QString proxyForUrl(const QString& url);
 226
 227     /**
 228      * Returns the proxy that should be used for a given protocol.
 229      * @param protocol the protocol.
 230      * @return The url of the proxy, or a empty string if no proxy should be used.
 231      */
 232     QString proxyForProtocol(const QString& protocol);
 233
 234     /*defined in collectionbrowser/collectiontreeitemmodel.cpp */
 235     /**
 236      * Small function aimed to convert Eagles, The -> The Eagles (and back again).
 237      * @param str the string to manipulate
 238      * @param reverse if true, The Eagles -> Eagles, The. If false, Eagles, The -> The Eagles
 239      */
 240     AMAROK_EXPORT void manipulateThe( QString &str, bool reverse );
 241
 242     ////////////////////////////////////////////////////////////////////////////////
 243     // class Amarok::ProcIO
 244     ////////////////////////////////////////////////////////////////////////////////
 245     /**
 246     * Due to xine-lib, we have to make K3Process close all fds, otherwise we get "device is busy" messages
 247     * Used by Amarok::ProcIO and AmarokProcess, exploiting commSetupDoneC(), a virtual method that
 248     * happens to be called in the forked process
 249     * See bug #103750 for more information.
 250     */
 251     class AMAROK_EXPORT ProcIO : public K3ProcIO {
 252         public:
 253         ProcIO(); // ctor sets the textcodec to UTF-8, in scriptmanager.cpp
 254         virtual int commSetupDoneC() {
 255             const int i = K3ProcIO::commSetupDoneC();
 256             Amarok::closeOpenFiles( K3ProcIO::out[0],K3ProcIO::in[0],K3ProcIO::err[0] );
 257             return i;
 258         }
 259     };
 260
 261     ////////////////////////////////////////////////////////////////////////////////
 262     // class Amarok::Process
 263     ////////////////////////////////////////////////////////////////////////////////
 264     /** Due to xine-lib, we have to make K3Process close all fds, otherwise we get "device is busy" messages
 265      * Used by Amarok::ProcIO and Amarok::Process, exploiting commSetupDoneC(), a virtual method that
 266      * happens to be called in the forked process
 267      * See bug #103750 for more information.
 268      */
 269     class AMAROK_EXPORT Process : public K3Process {
 270         public:
 271         Process( QObject *parent = 0 ) : K3Process( parent ) {}
 272         virtual int commSetupDoneC() {
 273             const int i = K3Process::commSetupDoneC();
 274             Amarok::closeOpenFiles(K3Process::out[0],K3Process::in[0], K3Process::err[0]);
 275             return i;
 276         }
 277     };
 278
 279
 280 }
 281
 282
 283 /**
 284  * Use this to const-iterate over QStringLists, if you like.
 285  * Watch out for the definition of last in the scope of your for.
 286  *
 287  *     QStringList strings;
 288  *     oldForeach( strings )
 289  *         debug() << *it << endl;
 290  */
 291 #define oldForeach( x ) \
 292     for( QStringList::ConstIterator it = x.begin(), end = x.end(); it != end; ++it )
 293
 294 /**
 295  * You can use this for lists that aren't QStringLists.
 296  * Watch out for the definition of last in the scope of your for.
 297  *
 298  *     BundleList bundles;
 299  *     oldForeachType( BundleList, bundles )
 300  *         debug() << *it.url() << endl;
 301  */
 302 #define oldForeachType( Type, x ) \
 303     for( Type::ConstIterator it = x.begin(), end = x.end(); it != end; ++it )
 304
 305 /**
 306  * Creates iterators of type @p Type.
 307  * Watch out for the definitions of last and end in your scope.
 308  *
 309  *     BundleList bundles;
 310  *     for( for_iterators( BundleList, bundles ); it != end; ++it )
 311  *         debug() << *it.url() << endl;
 312  */
 313 #define for_iterators( Type, x ) \
 314     Type::ConstIterator it = x.begin(), end = x.end(), last = x.fromLast()
 315
 316
 317 /// Update this when necessary
 318 #define APP_VERSION "2.0-SVN"
 319
 320 #endif