search_path.h

Go to the documentation of this file.

/*
    Copyright (C) 2007 Tim Mayberry 

    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, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __libpbd_search_path_h__
#define __libpbd_search_path_h__

#include <string>
#include <vector>

#include "pbd/libpbd_visibility.h"

namespace PBD {

class LIBPBD_TEMPLATE_API Searchpath : public std::vector<std::string>
{
public:
        LIBPBD_TEMPLATE_MEMBER_API Searchpath ();

        LIBPBD_TEMPLATE_MEMBER_API Searchpath (const std::string& search_path);

        LIBPBD_TEMPLATE_MEMBER_API Searchpath (const std::vector<std::string>& paths);

        LIBPBD_TEMPLATE_MEMBER_API ~Searchpath () {};

        LIBPBD_TEMPLATE_MEMBER_API const std::string to_string () const;

        LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator+= (const Searchpath& spath);

        LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator+= (const std::string& directory_path);
        
        LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator+ (const Searchpath& other);
        
        LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator+ (const std::string& directory_path);

        LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator-= (const Searchpath& spath);

        LIBPBD_TEMPLATE_MEMBER_API Searchpath& operator-= (const std::string& directory_path);

        LIBPBD_TEMPLATE_MEMBER_API Searchpath& add_subdirectory_to_paths (const std::string& subdir);

protected:

        LIBPBD_TEMPLATE_MEMBER_API void add_directory (const std::string& directory_path);
        LIBPBD_TEMPLATE_MEMBER_API void add_directories (const std::vector<std::string>& paths);
        LIBPBD_TEMPLATE_MEMBER_API void remove_directory (const std::string& directory_path);
        LIBPBD_TEMPLATE_MEMBER_API void remove_directories (const std::vector<std::string>& paths);
};

LIBPBD_API void export_search_path (const std::string& base_dir, const char* varname, const char* dir);


} // namespace PBD

#endif /* __libpbd_search_path_h__ */