filesystem.h

Go to the documentation of this file.

class file_info;


namespace foobar2000_io
{
    typedef t_uint64 t_filesize;
    typedef t_int64 t_sfilesize;
    typedef t_uint64 t_filetimestamp;
    const t_filetimestamp filetimestamp_invalid = 0;
    static const t_filesize filesize_invalid = (t_filesize)(~0);
    
    static const t_filetimestamp filetimestamp_1second_increment = 10000000;

    PFC_DECLARE_EXCEPTION(exception_io,                     pfc::exception,"I/O error");
    PFC_DECLARE_EXCEPTION(exception_io_not_found,           exception_io,"Object not found");
    PFC_DECLARE_EXCEPTION(exception_io_denied,              exception_io,"Access denied");
    PFC_DECLARE_EXCEPTION(exception_io_denied_readonly,     exception_io_denied,"File is read-only");
    PFC_DECLARE_EXCEPTION(exception_io_data,                exception_io,"Unsupported format or corrupted file");
    PFC_DECLARE_EXCEPTION(exception_io_data_truncation,     exception_io_data,"Unsupported format or corrupted file");
    PFC_DECLARE_EXCEPTION(exception_io_unsupported_format,  exception_io_data,"Unsupported file format");
    PFC_DECLARE_EXCEPTION(exception_io_object_is_remote,    exception_io,"This operation is not supported on remote objects");
    PFC_DECLARE_EXCEPTION(exception_io_sharing_violation,   exception_io,"File is already in use");
    PFC_DECLARE_EXCEPTION(exception_io_device_full,         exception_io,"Device full");
    PFC_DECLARE_EXCEPTION(exception_io_seek_out_of_range,   exception_io,"Seek offset out of range");
    PFC_DECLARE_EXCEPTION(exception_io_object_not_seekable, exception_io,"Object is not seekable");
    PFC_DECLARE_EXCEPTION(exception_io_no_length,           exception_io,"Length of object is unknown");
    PFC_DECLARE_EXCEPTION(exception_io_no_handler_for_path, exception_io,"Invalid path");
    PFC_DECLARE_EXCEPTION(exception_io_already_exists,      exception_io,"Object already exists");
    PFC_DECLARE_EXCEPTION(exception_io_no_data,             exception_io,"The process receiving or sending data has terminated");
    PFC_DECLARE_EXCEPTION(exception_io_network_not_reachable,exception_io,"Network not reachable");
    PFC_DECLARE_EXCEPTION(exception_io_write_protected,     exception_io_denied,"The media is write protected");
    PFC_DECLARE_EXCEPTION(exception_io_file_corrupted,      exception_io,"The file is corrupted");
    PFC_DECLARE_EXCEPTION(exception_io_disk_change,         exception_io,"Disc not available");
    PFC_DECLARE_EXCEPTION(exception_io_directory_not_empty, exception_io,"Directory not empty");
    PFC_DECLARE_EXCEPTION( exception_io_net, exception_io, "Connection error");
    PFC_DECLARE_EXCEPTION( exception_io_dns, exception_io_net, "DNS error");


    struct t_filestats {
        t_filesize m_size;
        t_filetimestamp m_timestamp;

        inline bool operator==(const t_filestats & param) const {return m_size == param.m_size && m_timestamp == param.m_timestamp;}
        inline bool operator!=(const t_filestats & param) const {return m_size != param.m_size || m_timestamp != param.m_timestamp;}
    };

    static const t_filestats filestats_invalid = {filesize_invalid,filetimestamp_invalid};

#ifdef _WIN32
    PFC_NORETURN void exception_io_from_win32(DWORD p_code);
#define WIN32_IO_OP(X) {SetLastError(NO_ERROR); if (!(X)) exception_io_from_win32(GetLastError());}

    // SPECIAL WORKAROUND: throw "file is read-only" rather than "access denied" where appropriate
    PFC_NORETURN void win32_file_write_failure(DWORD p_code, const char * path);
#endif

    class NOVTABLE stream_reader {
    public:
        virtual t_size read(void * p_buffer,t_size p_bytes,abort_callback & p_abort) = 0;
        virtual void read_object(void * p_buffer,t_size p_bytes,abort_callback & p_abort);
        virtual t_filesize skip(t_filesize p_bytes,abort_callback & p_abort);
        virtual void skip_object(t_filesize p_bytes,abort_callback & p_abort);

        template<typename T> inline void read_object_t(T& p_object,abort_callback & p_abort) {pfc::assert_raw_type<T>(); read_object(&p_object,sizeof(p_object),p_abort);}
        template<typename T> inline void read_lendian_t(T& p_object,abort_callback & p_abort) {read_object_t(p_object,p_abort); byte_order::order_le_to_native_t(p_object);}
        template<typename T> inline void read_bendian_t(T& p_object,abort_callback & p_abort) {read_object_t(p_object,p_abort); byte_order::order_be_to_native_t(p_object);}

        void read_string(pfc::string_base & p_out,abort_callback & p_abort);
        void read_string_raw(pfc::string_base & p_out,abort_callback & p_abort);
        pfc::string read_string(abort_callback & p_abort);

        void read_string_ex(pfc::string_base & p_out,t_size p_bytes,abort_callback & p_abort);
        pfc::string read_string_ex(t_size p_len,abort_callback & p_abort);

        void read_string_nullterm( pfc::string_base & out, abort_callback & abort );

        t_filesize skip_till_eof(abort_callback & abort);

        template<typename t_outArray>
        void read_till_eof(t_outArray & out, abort_callback & abort) {
            pfc::assert_raw_type<typename t_outArray::t_item>();
            const t_size itemWidth = sizeof(typename t_outArray::t_item);
            out.set_size(pfc::max_t<t_size>(1,256 / itemWidth)); t_size done = 0;
            for(;;) {
                t_size delta = out.get_size() - done;
                t_size delta2 = read(out.get_ptr() + done, delta * itemWidth, abort ) / itemWidth;
                done += delta2;
                if (delta2 != delta) break;
                out.set_size(out.get_size() << 1);
            }
            out.set_size(done);
        }
    protected:
        stream_reader() {}
        ~stream_reader() {}
    };


    class NOVTABLE stream_writer {
    public:
        virtual void write(const void * p_buffer,t_size p_bytes,abort_callback & p_abort) = 0;
        
        inline void write_object(const void * p_buffer,t_size p_bytes,abort_callback & p_abort) {write(p_buffer,p_bytes,p_abort);}

        template<typename T> inline void write_object_t(const T & p_object, abort_callback & p_abort) {pfc::assert_raw_type<T>(); write_object(&p_object,sizeof(p_object),p_abort);}
        template<typename T> inline void write_lendian_t(const T & p_object, abort_callback & p_abort) {T temp = p_object; byte_order::order_native_to_le_t(temp); write_object_t(temp,p_abort);}
        template<typename T> inline void write_bendian_t(const T & p_object, abort_callback & p_abort) {T temp = p_object; byte_order::order_native_to_be_t(temp); write_object_t(temp,p_abort);}

        void write_string(const char * p_string,abort_callback & p_abort);
        void write_string(const char * p_string,t_size p_len,abort_callback & p_abort);

        template<typename T>
        void write_string(const T& val,abort_callback & p_abort) {write_string(pfc::stringToPtr(val),p_abort);}

        void write_string_raw(const char * p_string,abort_callback & p_abort);

        void write_string_nullterm( const char * p_string, abort_callback & p_abort) {this->write( p_string, strlen(p_string)+1, p_abort); }
    protected:
        stream_writer() {}
        ~stream_writer() {}
    };

    class NOVTABLE file : public service_base, public stream_reader, public stream_writer {
    public:

        enum t_seek_mode {
            seek_from_beginning = 0,
            seek_from_current = 1,
            seek_from_eof = 2,
        };

        virtual t_filesize get_size(abort_callback & p_abort) = 0;


        virtual t_filesize get_position(abort_callback & p_abort) = 0;

        virtual void resize(t_filesize p_size,abort_callback & p_abort) = 0;

        virtual void seek(t_filesize p_position,abort_callback & p_abort) = 0;

        void seek_probe(t_filesize p_position, abort_callback & p_abort);
        
        virtual void seek_ex(t_sfilesize p_position,t_seek_mode p_mode,abort_callback & p_abort);

        virtual bool can_seek() = 0;

        virtual bool get_content_type(pfc::string_base & p_out) = 0;

        virtual bool is_in_memory() {return false;}

        virtual void on_idle(abort_callback & p_abort) {}

        virtual t_filetimestamp get_timestamp(abort_callback & p_abort) {return filetimestamp_invalid;}

        virtual void reopen(abort_callback & p_abort) = 0;
        
        virtual bool is_remote() = 0;
        
        t_filestats get_stats(abort_callback & p_abort);

        bool is_eof(abort_callback & p_abort);

        void truncate(t_filesize p_position,abort_callback & p_abort);

        void set_eof(abort_callback & p_abort) {resize(get_position(p_abort),p_abort);}


        t_filesize get_size_ex(abort_callback & p_abort);

        t_filesize get_remaining(abort_callback & p_abort);

        void probe_remaining(t_filesize bytes, abort_callback & p_abort);

        void ensure_seekable();

        void ensure_local();

        static t_filesize g_transfer(stream_reader * src,stream_writer * dst,t_filesize bytes,abort_callback & p_abort);
        static void g_transfer_object(stream_reader * src,stream_writer * dst,t_filesize bytes,abort_callback & p_abort);
        static void g_transfer_file(const service_ptr_t<file> & p_from,const service_ptr_t<file> & p_to,abort_callback & p_abort);

        static t_filesize g_transfer(service_ptr_t<file> p_src,service_ptr_t<file> p_dst,t_filesize p_bytes,abort_callback & p_abort);
        static void g_transfer_object(service_ptr_t<file> p_src,service_ptr_t<file> p_dst,t_filesize p_bytes,abort_callback & p_abort);


        t_filesize skip(t_filesize p_bytes,abort_callback & p_abort);
        t_filesize skip_seek(t_filesize p_bytes,abort_callback & p_abort);

        FB2K_MAKE_SERVICE_INTERFACE(file,service_base);
    };

    typedef service_ptr_t<file> file_ptr;

    class file_dynamicinfo : public file {
        FB2K_MAKE_SERVICE_INTERFACE(file_dynamicinfo,file);
    public:
        virtual bool get_static_info(class file_info & p_out) = 0;
        virtual bool is_dynamic_info_enabled()=0;
        virtual bool get_dynamic_info(class file_info & p_out) = 0;
    };

    class file_cached : public file {
        FB2K_MAKE_SERVICE_INTERFACE(file_cached, file);
    public:
        virtual size_t get_cache_block_size() = 0;
        virtual void suggest_grow_cache(size_t suggestSize) = 0;

        static file::ptr g_create(service_ptr_t<file> p_base,abort_callback & p_abort, t_size blockSize);
        static void g_create(service_ptr_t<file> & p_out,service_ptr_t<file> p_base,abort_callback & p_abort, t_size blockSize);

        static void g_decodeInitCache(file::ptr & theFile, abort_callback & abort, size_t blockSize);
    };

    template<typename t_base> class file_readonly_t : public t_base {
    public:
        void resize(t_filesize p_size,abort_callback & p_abort) {throw exception_io_denied();}
        void write(const void * p_buffer,t_size p_bytes,abort_callback & p_abort) {throw exception_io_denied();}
    };
    typedef file_readonly_t<file> file_readonly;

    class file_streamstub : public file_readonly {
    public:
        t_size read(void * p_buffer,t_size p_bytes,abort_callback & p_abort) {return 0;}
        t_filesize get_size(abort_callback & p_abort) {return filesize_invalid;}
        t_filesize get_position(abort_callback & p_abort) {return 0;}
        bool get_content_type(pfc::string_base & p_out) {return false;}
        bool is_remote() {return true;}
        void reopen(abort_callback&) {}
        void seek(t_filesize p_position,abort_callback & p_abort) {throw exception_io_object_not_seekable();}
        bool can_seek() {return false;}
    };

    class filesystem;

    class NOVTABLE directory_callback {
    public:
        virtual bool on_entry(filesystem * p_owner,abort_callback & p_abort,const char * p_url,bool p_is_subdirectory,const t_filestats & p_stats)=0;
    };


    class NOVTABLE filesystem : public service_base {
        FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(filesystem);
    public:
        enum t_open_mode {
            open_mode_read,
            open_mode_write_existing,
            open_mode_write_new,
        };

        virtual bool get_canonical_path(const char * p_path,pfc::string_base & p_out)=0;
        virtual bool is_our_path(const char * p_path)=0;
        virtual bool get_display_path(const char * p_path,pfc::string_base & p_out)=0;

        virtual void open(service_ptr_t<file> & p_out,const char * p_path, t_open_mode p_mode,abort_callback & p_abort)=0;
        virtual void remove(const char * p_path,abort_callback & p_abort)=0;
        virtual void move(const char * p_src,const char * p_dst,abort_callback & p_abort)=0;
        virtual bool is_remote(const char * p_src) = 0;

        virtual void get_stats(const char * p_path,t_filestats & p_stats,bool & p_is_writeable,abort_callback & p_abort) = 0;
        
        virtual bool relative_path_create(const char * file_path,const char * playlist_path,pfc::string_base & out) {return false;}
        virtual bool relative_path_parse(const char * relative_path,const char * playlist_path,pfc::string_base & out) {return false;}

        virtual void create_directory(const char * p_path,abort_callback & p_abort) = 0;

        virtual void list_directory(const char * p_path,directory_callback & p_out,abort_callback & p_abort)=0;

        virtual bool supports_content_types() = 0;

        static void g_get_canonical_path(const char * path,pfc::string_base & out);
        static void g_get_display_path(const char * path,pfc::string_base & out);
        static bool g_get_native_path( const char * path, pfc::string_base & out);

        static bool g_get_interface(service_ptr_t<filesystem> & p_out,const char * path);//path is AFTER get_canonical_path
        static filesystem::ptr g_get_interface(const char * path);// throws exception_io_no_handler_for_path on failure
        static bool g_is_remote(const char * p_path);//path is AFTER get_canonical_path
        static bool g_is_recognized_and_remote(const char * p_path);//path is AFTER get_canonical_path
        static bool g_is_remote_safe(const char * p_path) {return g_is_recognized_and_remote(p_path);}
        static bool g_is_remote_or_unrecognized(const char * p_path);
        static bool g_is_recognized_path(const char * p_path);
        
        static void g_open(service_ptr_t<file> & p_out,const char * p_path,t_open_mode p_mode,abort_callback & p_abort);
        static void g_open_timeout(service_ptr_t<file> & p_out,const char * p_path,t_open_mode p_mode,double p_timeout,abort_callback & p_abort);
        static void g_open_write_new(service_ptr_t<file> & p_out,const char * p_path,abort_callback & p_abort);
        static void g_open_read(service_ptr_t<file> & p_out,const char * path,abort_callback & p_abort) {return g_open(p_out,path,open_mode_read,p_abort);}
        static void g_open_precache(service_ptr_t<file> & p_out,const char * path,abort_callback & p_abort);//open only for precaching data (eg. will fail on http etc)
        static bool g_exists(const char * p_path,abort_callback & p_abort);
        static bool g_exists_writeable(const char * p_path,abort_callback & p_abort);
        static void g_remove(const char * p_path,abort_callback & p_abort);
        static void g_remove_timeout(const char * p_path,double p_timeout,abort_callback & p_abort);
        static void g_move(const char * p_src,const char * p_dst,abort_callback & p_abort);
        static void g_move_timeout(const char * p_src,const char * p_dst,double p_timeout,abort_callback & p_abort);

        static void g_link(const char * p_src,const char * p_dst,abort_callback & p_abort);
        static void g_link_timeout(const char * p_src,const char * p_dst,double p_timeout,abort_callback & p_abort);

        static void g_copy(const char * p_src,const char * p_dst,abort_callback & p_abort);//needs canonical path
        static void g_copy_timeout(const char * p_src,const char * p_dst,double p_timeout,abort_callback & p_abort);//needs canonical path
        static void g_copy_directory(const char * p_src,const char * p_dst,abort_callback & p_abort);//needs canonical path
        static void g_get_stats(const char * p_path,t_filestats & p_stats,bool & p_is_writeable,abort_callback & p_abort);
        static bool g_relative_path_create(const char * p_file_path,const char * p_playlist_path,pfc::string_base & out);
        static bool g_relative_path_parse(const char * p_relative_path,const char * p_playlist_path,pfc::string_base & out);
        
        static void g_create_directory(const char * p_path,abort_callback & p_abort);

        static FILE * streamio_open(const char * p_path,const char * p_flags); 

        static void g_open_temp(service_ptr_t<file> & p_out,abort_callback & p_abort);
        static void g_open_tempmem(service_ptr_t<file> & p_out,abort_callback & p_abort);
        static file::ptr g_open_tempmem();

        static void g_list_directory(const char * p_path,directory_callback & p_out,abort_callback & p_abort);// path must be canonical

        static bool g_is_valid_directory(const char * path,abort_callback & p_abort);
        static bool g_is_empty_directory(const char * path,abort_callback & p_abort);

        void remove_object_recur(const char * path, abort_callback & abort);
        void remove_directory_content(const char * path, abort_callback & abort);
        static void g_remove_object_recur(const char * path, abort_callback & abort);
        static void g_remove_object_recur_timeout(const char * path, double timeout, abort_callback & abort);

        // Presumes both source and destination belong to this filesystem.
        void copy_directory(const char * p_src, const char * p_dst, abort_callback & p_abort);
    };

    class directory_callback_impl : public directory_callback
    {
        struct t_entry
        {
            pfc::string_simple m_path;
            t_filestats m_stats;
            t_entry(const char * p_path, const t_filestats & p_stats) : m_path(p_path), m_stats(p_stats) {}
        };


        pfc::list_t<pfc::rcptr_t<t_entry> > m_data;
        bool m_recur;

        static int sortfunc(const pfc::rcptr_t<const t_entry> & p1, const pfc::rcptr_t<const t_entry> & p2) {return pfc::io::path::compare(p1->m_path,p2->m_path);}
    public:
        bool on_entry(filesystem * owner,abort_callback & p_abort,const char * url,bool is_subdirectory,const t_filestats & p_stats);

        directory_callback_impl(bool p_recur) : m_recur(p_recur) {}
        t_size get_count() {return m_data.get_count();}
        const char * operator[](t_size n) const {return m_data[n]->m_path;}
        const char * get_item(t_size n) const {return m_data[n]->m_path;}
        const t_filestats & get_item_stats(t_size n) const {return m_data[n]->m_stats;}
        void sort() {m_data.sort_t(sortfunc);}
    };

    class archive;

    class NOVTABLE archive_callback : public abort_callback {
    public:
        virtual bool on_entry(archive * owner,const char * url,const t_filestats & p_stats,const service_ptr_t<file> & p_reader) = 0;
    };

    class NOVTABLE archive : public filesystem {
    public:
        virtual void archive_list(const char * p_path,const service_ptr_t<file> & p_reader,archive_callback & p_callback,bool p_want_readers) = 0;
        
        FB2K_MAKE_SERVICE_INTERFACE(archive,filesystem);
    };

    class NOVTABLE archive_impl : public archive {
    private:
        //do not override these
        bool get_canonical_path(const char * path,pfc::string_base & out);
        bool is_our_path(const char * path);
        bool get_display_path(const char * path,pfc::string_base & out);
        void remove(const char * path,abort_callback & p_abort);
        void move(const char * src,const char * dst,abort_callback & p_abort);
        bool is_remote(const char * src);
        bool relative_path_create(const char * file_path,const char * playlist_path,pfc::string_base & out);
        bool relative_path_parse(const char * relative_path,const char * playlist_path,pfc::string_base & out);
        void open(service_ptr_t<file> & p_out,const char * path, t_open_mode mode,abort_callback & p_abort);
        void create_directory(const char * path,abort_callback &);
        void list_directory(const char * p_path,directory_callback & p_out,abort_callback & p_abort);
        void get_stats(const char * p_path,t_filestats & p_stats,bool & p_is_writeable,abort_callback & p_abort);
    protected:
        //override these
        virtual const char * get_archive_type()=0;//eg. "zip", must be lowercase
        virtual t_filestats get_stats_in_archive(const char * p_archive,const char * p_file,abort_callback & p_abort) = 0;
        virtual void open_archive(service_ptr_t<file> & p_out,const char * archive,const char * file, abort_callback & p_abort)=0;//opens for reading
    public:
        //override these
        virtual void archive_list(const char * path,const service_ptr_t<file> & p_reader,archive_callback & p_out,bool p_want_readers)=0;

        
        static bool g_is_unpack_path(const char * path);
        static bool g_parse_unpack_path(const char * path,pfc::string_base & archive,pfc::string_base & file);
        static bool g_parse_unpack_path_ex(const char * path,pfc::string_base & archive,pfc::string_base & file, pfc::string_base & type);
        static void g_make_unpack_path(pfc::string_base & path,const char * archive,const char * file,const char * type);
        void make_unpack_path(pfc::string_base & path,const char * archive,const char * file);

        
    };

    template<typename T>
    class archive_factory_t : public service_factory_single_t<T> {};


    t_filetimestamp filetimestamp_from_system_timer();

#ifdef _WIN32
    inline t_filetimestamp import_filetimestamp(FILETIME ft) {
        return *reinterpret_cast<t_filetimestamp*>(&ft);
    }
#endif

    void generate_temp_location_for_file(pfc::string_base & p_out, const char * p_origpath,const char * p_extension,const char * p_magic);


    inline file_ptr fileOpen(const char * p_path,filesystem::t_open_mode p_mode,abort_callback & p_abort,double p_timeout) {
        file_ptr temp; filesystem::g_open_timeout(temp,p_path,p_mode,p_timeout,p_abort); PFC_ASSERT(temp.is_valid()); return temp;
    }

    inline file_ptr fileOpenReadExisting(const char * p_path,abort_callback & p_abort,double p_timeout = 0) {
        return fileOpen(p_path,filesystem::open_mode_read,p_abort,p_timeout);
    }
    inline file_ptr fileOpenWriteExisting(const char * p_path,abort_callback & p_abort,double p_timeout = 0) {
        return fileOpen(p_path,filesystem::open_mode_write_existing,p_abort,p_timeout);
    }
    inline file_ptr fileOpenWriteNew(const char * p_path,abort_callback & p_abort,double p_timeout = 0) {
        return fileOpen(p_path,filesystem::open_mode_write_new,p_abort,p_timeout);
    }
    
    template<typename t_list>
    class directory_callback_retrieveList : public directory_callback {
    public:
        directory_callback_retrieveList(t_list & p_list,bool p_getFiles,bool p_getSubDirectories) : m_list(p_list), m_getFiles(p_getFiles), m_getSubDirectories(p_getSubDirectories) {}
        bool on_entry(filesystem * p_owner,abort_callback & p_abort,const char * p_url,bool p_is_subdirectory,const t_filestats & p_stats) {
            p_abort.check();
            if (p_is_subdirectory ? m_getSubDirectories : m_getFiles) {
                m_list.add_item(p_url);
            }
            return true;
        }
    private:
        const bool m_getSubDirectories;
        const bool m_getFiles;
        t_list & m_list;
    };
    template<typename t_list>
    class directory_callback_retrieveListEx : public directory_callback {
    public:
        directory_callback_retrieveListEx(t_list & p_files, t_list & p_directories) : m_files(p_files), m_directories(p_directories) {}
        bool on_entry(filesystem * p_owner,abort_callback & p_abort,const char * p_url,bool p_is_subdirectory,const t_filestats & p_stats) {
            p_abort.check();
            if (p_is_subdirectory) m_directories += p_url;
            else m_files += p_url;
            return true;
        }
    private:
        t_list & m_files;
        t_list & m_directories;
    };
    template<typename t_list> class directory_callback_retrieveListRecur : public directory_callback {
    public:
        directory_callback_retrieveListRecur(t_list & p_list) : m_list(p_list) {}
        bool on_entry(filesystem * owner,abort_callback & p_abort,const char * path, bool isSubdir, const t_filestats&) {
            if (isSubdir) {
                try { owner->list_directory(path,*this,p_abort); } catch(exception_io) {}
            } else {
                m_list.add_item(path);
            }
            return true;
        }
    private:
        t_list & m_list;
    };

    template<typename t_list>
    static void listFiles(const char * p_path,t_list & p_out,abort_callback & p_abort) {
        directory_callback_retrieveList<t_list> callback(p_out,true,false);
        filesystem::g_list_directory(p_path,callback,p_abort);
    }
    template<typename t_list>
    static void listDirectories(const char * p_path,t_list & p_out,abort_callback & p_abort) {
        directory_callback_retrieveList<t_list> callback(p_out,false,true);
        filesystem::g_list_directory(p_path,callback,p_abort);
    }
    template<typename t_list>
    static void listFilesAndDirectories(const char * p_path,t_list & p_files,t_list & p_directories,abort_callback & p_abort) {
        directory_callback_retrieveListEx<t_list> callback(p_files,p_directories);
        filesystem::g_list_directory(p_path,callback,p_abort);
    }
    template<typename t_list>
    static void listFilesRecur(const char * p_path,t_list & p_out,abort_callback & p_abort) {
        directory_callback_retrieveListRecur<t_list> callback(p_out);
        filesystem::g_list_directory(p_path,callback,p_abort);
    }

    bool extract_native_path(const char * p_fspath,pfc::string_base & p_native);
    bool _extract_native_path_ptr(const char * & p_fspath);
    bool is_native_filesystem( const char * p_fspath );
    bool extract_native_path_ex(const char * p_fspath, pfc::string_base & p_native);//prepends \\?\ where needed

    template<typename T>
    pfc::string getPathDisplay(const T& source) {
        pfc::string_formatter temp;
        filesystem::g_get_display_path(pfc::stringToPtr(source),temp);
        return temp.toString();
    }
    template<typename T>
    pfc::string getPathCanonical(const T& source) {
        pfc::string_formatter temp;
        filesystem::g_get_canonical_path(pfc::stringToPtr(source),temp);
        return temp.toString();
    }


    bool matchContentType(const char * fullString, const char * ourType);
    bool matchProtocol(const char * fullString, const char * protocolName);
    void substituteProtocol(pfc::string_base & out, const char * fullString, const char * protocolName);

    void purgeOldFiles(const char * directory, t_filetimestamp period, abort_callback & abort);
}

using namespace foobar2000_io;

#include "filesystem_helper.h"