Filesystem.h

Go to the documentation of this file.

/*
 * Hydrogen
 * Copyright(c) 2002-2008 by Alex >Comix< Cominu [comix@users.sourceforge.net]
 * Copyright(c) 2008-2025 The hydrogen development team [hydrogen-devel@lists.sourceforge.net]
 *
 * http://www.hydrogen-music.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see https://www.gnu.org/licenses
 *
 */
 
#ifndef H2C_FILESYSTEM_H
#define H2C_FILESYSTEM_H
 
#include <core/Object.h>
#include <QtCore/QString>
 
#include <vector>
 
namespace H2Core
{

        class Filesystem : public H2Core::Object<Filesystem>
        {
                H2_OBJECT(Filesystem)
                public:
                enum file_perms {
                                                 is_dir =0x01,
                                                 is_file=0x02,
                                                 is_readable=0x04,
                                                 is_writable=0x08,
                                                 is_executable=0x10
                };
                
        enum class Lookup {
                stacked = 0,
                user = 1,
                system = 2
        };

                enum class DrumkitType {
                        System = 0,
                        User = 1,
                        SessionReadOnly = 2,
                        SessionReadWrite = 3
                };

                        enum class AudioFormat {
                                Aif,
                                Aifc,
                                Aiff,
                                Au,
                                Caf,
                                Flac,
                                Mp3,
                                Ogg,
                                Opus,
                                Unknown,
                                Voc,
                                W64,
                                Wav
                        };

                        static QString AudioFormatToSuffix( const AudioFormat& format,
                                                                                                bool bSilent = false  );
                        static AudioFormat AudioFormatFromSuffix( const QString& sFile,
                                                                                                          bool bSilent = false );
 
 
                static const QString songs_ext;
                static const QString scripts_ext;
                static const QString patterns_ext;
                static const QString playlist_ext;
                static const QString drumkit_ext;
                static const QString themes_ext;
                static const QString songs_filter_name;
                static const QString themes_filter_name;
                static const QString scripts_filter_name;
                static const QString patterns_filter_name;
                static const QString playlists_filter_name;

                static bool bootstrap( Logger* logger,
                                                           const QString& sSysDataPath = "",
                                                           const QString& sUsrDataPath = "",
                                                           const QString& sUserConfigFile = "",
                                                           const QString& sLogFile = "" );

                static QString sys_data_path();
                static QString usr_data_path();

                static QStringList ladspa_paths();

                static QString sys_config_path();
                static QString usr_config_path();
                static QString empty_sample_path();
                static QString empty_song_path();
                static QString default_song_name();
                static QString untitled_song_name();
                static QString click_file_path();
                static QString usr_click_file_path();
                static QString drumkit_xsd( );
                static QString drumkit_xsd_path( );
                static QStringList drumkit_xsd_legacy_paths( );
                static QString pattern_xsd_path( );
                static QString playlist_xsd_path( );
                static QString log_file_path();

                static QString img_dir();
                static QString doc_dir();
                static QString i18n_dir();
                static QString scripts_dir();
                static QString songs_dir();
                static QString song_path( const QString& sg_name );
                static QString patterns_dir();
                static QString patterns_dir( const QString& dk_name );
                static QString pattern_path( const QString& dk_name, const QString& p_name );
                static QString plugins_dir();
                static QString sys_drumkits_dir();
                static QString usr_drumkits_dir();
                static QString playlists_dir();
                static QString playlist_path( const QString& pl_name );
                static QString untitled_playlist_file_name();
                static QString cache_dir();
                static QString repositories_cache_dir();
                static QString demos_dir();
                static QString xsd_dir();
                static QString xsd_legacy_dir();
                static QString tmp_dir();
                static QString usr_theme_dir();
                static QString sys_theme_dir();
                static QString tmp_file_path( const QString& base );
 
                /* DRUMKIT */
                static QString prepare_sample_path( const QString& sFilePath );
                static QStringList sys_drumkit_list( );
                static QStringList usr_drumkit_list( );
                static bool drumkit_exists( const QString& dk_name );
                static QString drumkit_usr_path( const QString& dk_name );
                static QString drumkit_default_kit();
                static QString drumkit_path_search( const QString& dk_name, Lookup lookup = Lookup::stacked, bool bSilent = false );
                static QString drumkit_dir_search( const QString& dk_name, Lookup lookup );
                static bool drumkit_valid( const QString& dk_path );
                static QString drumkit_file( const QString& dk_path );

                static QString drumkit_xml();

                static QString drumkit_backup_path( const QString& dk_path );
 
                /* PATTERNS */
                static QStringList pattern_drumkits();
                static QStringList pattern_list();
                static QStringList pattern_list( const QString& path );
 
                /* SONGS */
                static QStringList song_list( );
                static QStringList song_list_cleared( );
                static bool song_exists( const QString& sg_name );
                
                static bool isSongPathValid( const QString& sSongPath, bool bCheckExistance = false );

                static QString validateFilePath( const QString& sPath );
 
                static QStringList theme_list();

                static void info();
 
                /* PLAYLISTS */
                static QStringList playlist_list( );

                static bool file_exists( const QString& path, bool silent=false );
                static bool file_readable( const QString& path, bool silent=false );
                static bool file_writable( const QString& path, bool silent=false );
                static bool file_executable( const QString& path, bool silent=false );
                static bool dir_exists( const QString& path, bool silent=false );
                static bool dir_readable( const QString& path, bool silent=false );
                static bool dir_writable( const QString& path, bool silent=false );
                static bool path_usable( const QString& path, bool create=true, bool silent=false );

                static QString absolute_path( const QString& sFilename, bool bSilent = false );
                static QString ensure_session_compatibility( const QString& sPath );
                static bool write_to_file( const QString& dst, const QString& content );
                static bool file_copy( const QString& src, const QString& dst, bool overwrite=false, bool bSilent = false );
                static bool rm( const QString& path, bool recursive=false, bool bSilent = false );
                static bool mkdir( const QString& path );

                static const QString& getPreferencesOverwritePath();
                static void setPreferencesOverwritePath( const QString& sPath );

                static DrumkitType determineDrumkitType( const QString& sPath );

                static QString rerouteDrumkitPath( const QString& sDrumkitPath );

                        static QString removeUtf8Characters( const QString& sEncodedString );

                         static const std::vector<AudioFormat>& supportedAudioFormats();
 
        private:
                static Logger* __logger;                    
                static bool check_sys_paths();              
                static bool check_usr_paths();              
                static bool rm_fr( const QString& path, bool bSilent = false );   

                static QString m_sPreferencesOverwritePath;
                static QStringList drumkit_list( const QString& path );
                static bool check_permissions( const QString& path, const int perms, bool silent );

                static QString __sys_data_path;     
                static QString __usr_data_path;     
                static QString __usr_cfg_path;      
                static QString __usr_log_path;      
                static QStringList __ladspa_paths;  
                        static std::vector<AudioFormat> m_supportedAudioFormats;
        };
 
        inline const QString& Filesystem::getPreferencesOverwritePath() {
                return Filesystem::m_sPreferencesOverwritePath;
        }
        inline void Filesystem::setPreferencesOverwritePath( const QString& sPath ) {
                Filesystem::m_sPreferencesOverwritePath = sPath;
        }
 
};
#endif  // H2C_FILESYSTEM_H
 
/* vim: set softtabstop=4 noexpandtab: */