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      * An event handler that handles events in a generic Amarok fashion. Mainly
  70      * useful for drops, ie offers the Amarok popup for adding tracks to the
  71      * playlist. You shouldn't pass every event here, ie closeEvents will not be
  72      * handled as expected! Check the source in app.cpp if you want to see what
  73      * it can do.
  74      * @param recipient The object that received the event.
  75      * @param e The event you want handled in a generic fashion.
  76      * @return true if the event was handled.
  77      */
  78     bool genericEventHandler( QWidget *recipient, QEvent *e ); //defined in app.cpp
  79
  80     /**
  81      * Invoke the external web browser set in Amarok's configuration.
  82      * @param url The URL to be opened in the browser.
  83      * @return True if the browser could be started.
  84      */
  85     bool invokeBrowser( const QString& url ); //defined in app.cpp
  86
  87     /**
  88      * The mainWindow is the playlistWindow
  89      */
  90     AMAROK_EXPORT QWidget *mainWindow(); //defined in app.cpp
  91
  92     /**
  93      * Allocate one on the stack, and it'll set the busy cursor for you until it
  94      * is destroyed
  95      */
  96     class OverrideCursor { //defined in app.cpp
  97     public:
  98         OverrideCursor( Qt::CursorShape cursor = Qt::WaitCursor );
  99        ~OverrideCursor();
 100     };
 101
 102     /**
 103      * For saving files to ~/.kde/share/apps/amarok/directory
 104      * @param directory will be created if not existing, you MUST end the string
 105      *                  with '/'
 106      */
 107     AMAROK_EXPORT QString saveLocation( const QString &directory = QString() ); //defined in collectionreader.cpp
 108
 109     KIO::Job *trashFiles( const KUrl::List &files ); //defined in app.cpp
 110
 111     /**
 112      * For recursively expanding the contents of a directory into a KUrl::List
 113      * (playlists are ignored)
 114      */
 115     //PORT 2.0
 116 //     AMAROK_EXPORT KUrl::List recursiveUrlExpand( const KUrl &url, int maxURLs = -1 ); //defined in playlistloader.cpp
 117 //     AMAROK_EXPORT KUrl::List recursiveUrlExpand( const KUrl::List &urls, int maxURLs = -1 ); //defined in playlistloader.cpp
 118
 119     QString verboseTimeSince( const QDateTime &datetime ); //defined in tracktooltip.cpp
 120
 121     QString verboseTimeSince( uint time_t ); //defined in tracktooltip.cpp
 122
 123     /**
 124      * Function that must be used when separating contextBrowser escaped urls
 125      */
 126     // defined in Statistics.cpp
 127     void albumArtistTrackFromUrl( QString url, QString &artist, QString &album, QString &detail );
 128
 129     /**
 130      * @return the LOWERCASE file extension without the preceding '.', or "" if there is none
 131      */
 132     inline QString extension( const QString &fileName )
 133     {
 134         return fileName.contains( '.' ) ? fileName.mid( fileName.lastIndexOf( '.' ) + 1 ).toLower() : "";
 135     }
 136
 137     /** Transform url into a file url if possible */
 138     inline KUrl mostLocalURL( const KUrl &url )
 139     {
 140         return KIO::NetAccess::mostLocalUrl( url, mainWindow() );
 141     }
 142
 143     /**
 144      * @return the last directory in @param fileName
 145      */
 146     inline QString directory( const QString &fileName )
 147     {
 148         return fileName.section( '/', 0, -2 );
 149     }
 150   /** Due to xine-lib, we have to make K3Process close all fds, otherwise we get "device is busy" messages
 151   * Used by Amarok::ProcIO and Amarok::Process, exploiting commSetupDoneC(), a virtual method that
 152   * happens to be called in the forked process
 153   * See bug #103750 for more information.
 154   */
 155   //TODO ugly hack, fix K3Process for KDE 4.0
 156     void closeOpenFiles(int out, int in, int err); //defined in scriptmanager.cpp
 157
 158     /**
 159     * Returns internal code for database type, DbConnection::sqlite, DbConnection::mysql, or DbConnection::postgresql
 160     * @param type either "SQLite", "MySQL", or "Postgresql".
 161     */
 162     int databaseTypeCode( const QString type ); //defined in configdialog.cpp
 163
 164     void setUseScores( bool use ); //defined in app.cpp
 165     void setUseRatings( bool use );
 166     void setMoodbarPrefs( bool show, bool moodier, int alter, bool withMusic );
 167
 168     bool repeatNone(); //defined in actionclasses.cpp
 169     bool repeatTrack();
 170     bool repeatAlbum();
 171     bool repeatPlaylist();
 172     bool randomOff();
 173     bool randomTracks();
 174     bool randomAlbums();
 175     bool favorNone();
 176     bool favorScores();
 177     bool favorRatings();
 178     bool favorLastPlay();
 179     bool entireAlbums(); //repeatAlbum() || randomAlbums()
 180
 181 // Port 2.0: Reenable when we have a new dynamic mode
 182 //     const DynamicMode *dynamicMode(); //defined in playlist.cpp
 183
 184     QStringList splitPath( QString path ); //defined in playlistbrowser.cpp
 185
 186     /**
 187      * Maps the icon name to a system icon or custom Amarok icon, depending on the settings.
 188      */
 189     AMAROK_EXPORT QString icon( const QString& name ); //defined in iconloader.cpp
 190
 191     /**
 192      * Removes accents from the string
 193      * @param path The original path.
 194      * @return The cleaned up path.
 195      */
 196     AMAROK_EXPORT QString cleanPath( const QString &path ); //defined in app.cpp
 197
 198     /**
 199      * Replaces all non-ASCII characters with '_'.
 200      * @param path The original path.
 201      * @return The ASCIIfied path.
 202      */
 203     AMAROK_EXPORT QString asciiPath( const QString &path ); //defined in app.cpp
 204
 205     /**
 206      * Transform path into one valid on VFAT file systems
 207      * @param path The original path.
 208      * @return The cleaned up path.
 209      */
 210     AMAROK_EXPORT QString vfatPath( const QString &path ); //defined in app.cpp
 211
 212     /**
 213      * Compare both strings from left to right and remove the common part from input
 214      * @param input the string that get's cleaned.
 215      * @param ref a reference to compare input with.
 216      * @return The cleaned up string.
 217      */
 218     AMAROK_EXPORT QString decapitateString( const QString &input, const QString &ref );
 219
 220     /*
 221      * Transform to be usable within HTML/HTML attributes
 222      */
 223     AMAROK_EXPORT QString escapeHTMLAttr( const QString &s );
 224     AMAROK_EXPORT QString unescapeHTMLAttr( const QString &s ); //defined in statistics.cpp
 225
 226     /* defined in scriptmanager.cpp */
 227     /**
 228      * Returns the proxy that should be used for a given URL.
 229      * @param url the url.
 230      * @return The url of the proxy, or a empty string if no proxy should be used.
 231      */
 232     QString proxyForUrl(const QString& url);
 233
 234     /**
 235      * Returns the proxy that should be used for a given protocol.
 236      * @param protocol the protocol.
 237      * @return The url of the proxy, or a empty string if no proxy should be used.
 238      */
 239     QString proxyForProtocol(const QString& protocol);
 240
 241     /*defined in collectionbrowser/collectiontreeitemmodel.cpp */
 242     /**
 243      * Small function aimed to convert Eagles, The -> The Eagles (and back again).
 244      * @param str the string to manipulate
 245      * @param reverse if true, The Eagles -> Eagles, The. If false, Eagles, The -> The Eagles
 246      */
 247     AMAROK_EXPORT void manipulateThe( QString &str, bool reverse );
 248
 249     ////////////////////////////////////////////////////////////////////////////////
 250     // class Amarok::ProcIO
 251     ////////////////////////////////////////////////////////////////////////////////
 252     /**
 253     * Due to xine-lib, we have to make K3Process close all fds, otherwise we get "device is busy" messages
 254     * Used by Amarok::ProcIO and AmarokProcess, exploiting commSetupDoneC(), a virtual method that
 255     * happens to be called in the forked process
 256     * See bug #103750 for more information.
 257     */
 258     class AMAROK_EXPORT ProcIO : public K3ProcIO {
 259         public:
 260         ProcIO(); // ctor sets the textcodec to UTF-8, in scriptmanager.cpp
 261         virtual int commSetupDoneC() {
 262             const int i = K3ProcIO::commSetupDoneC();
 263             Amarok::closeOpenFiles( K3ProcIO::out[0],K3ProcIO::in[0],K3ProcIO::err[0] );
 264             return i;
 265         }
 266     };
 267
 268     ////////////////////////////////////////////////////////////////////////////////
 269     // class Amarok::Process
 270     ////////////////////////////////////////////////////////////////////////////////
 271     /** Due to xine-lib, we have to make K3Process close all fds, otherwise we get "device is busy" messages
 272      * Used by Amarok::ProcIO and Amarok::Process, exploiting commSetupDoneC(), a virtual method that
 273      * happens to be called in the forked process
 274      * See bug #103750 for more information.
 275      */
 276     class AMAROK_EXPORT Process : public K3Process {
 277         public:
 278         Process( QObject *parent = 0 ) : K3Process( parent ) {}
 279         virtual int commSetupDoneC() {
 280             const int i = K3Process::commSetupDoneC();
 281             Amarok::closeOpenFiles(K3Process::out[0],K3Process::in[0], K3Process::err[0]);
 282             return i;
 283         }
 284     };
 285
 286
 287 }
 288
 289
 290 /**
 291  * Use this to const-iterate over QStringLists, if you like.
 292  * Watch out for the definition of last in the scope of your for.
 293  *
 294  *     QStringList strings;
 295  *     oldForeach( strings )
 296  *         debug() << *it << endl;
 297  */
 298 #define oldForeach( x ) \
 299     for( QStringList::ConstIterator it = x.begin(), end = x.end(); it != end; ++it )
 300
 301 /**
 302  * You can use this for lists that aren't QStringLists.
 303  * Watch out for the definition of last in the scope of your for.
 304  *
 305  *     BundleList bundles;
 306  *     oldForeachType( BundleList, bundles )
 307  *         debug() << *it.url() << endl;
 308  */
 309 #define oldForeachType( Type, x ) \
 310     for( Type::ConstIterator it = x.begin(), end = x.end(); it != end; ++it )
 311
 312 /**
 313  * Creates iterators of type @p Type.
 314  * Watch out for the definitions of last and end in your scope.
 315  *
 316  *     BundleList bundles;
 317  *     for( for_iterators( BundleList, bundles ); it != end; ++it )
 318  *         debug() << *it.url() << endl;
 319  */
 320 #define for_iterators( Type, x ) \
 321     Type::ConstIterator it = x.begin(), end = x.end(), last = x.fromLast()
 322
 323
 324 /// Update this when necessary
 325 #define APP_VERSION "2.0-SVN"
 326
 327 #endif