/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2022 Denis Corbin
//
// 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// to contact the author, see the AUTHOR file
/*********************************************************************/

    /// \file fsa_family.hpp
    /// \brief filesystem specific attributes available families and fsa_scope definition
    /// \ingroup API

#ifndef FSA_FAMILY_HPP
#define FSA_FAMILY_HPP

#include <string>
#include <set>

#include "/usr/pkg/include/dar/integers.hpp"

namespace libdar
{
	/// \addtogroup API
	/// @{


	/// FSA family

    enum fsa_family { fsaf_hfs_plus, fsaf_linux_extX };
	// note: adding new fsa_family need updating all_fsa_family()



	/// FSA nature
    enum fsa_nature { fsan_unset,
		      fsan_creation_date,
		      fsan_append_only,
		      fsan_compressed,
		      fsan_no_dump,
		      fsan_immutable,
		      fsan_data_journaling,
		      fsan_secure_deletion,
		      fsan_no_tail_merging,
		      fsan_undeletable,
		      fsan_noatime_update,
		      fsan_synchronous_directory,
		      fsan_synchronous_update,
		      fsan_top_of_dir_hierarchy };

	/// convert fsa family to readable std::string
    extern std::string fsa_family_to_string(fsa_family f);

	/// convert fsa nature to readable std::string
    extern std::string fsa_nature_to_string(fsa_nature n);

	/// set of fsa families
    using fsa_scope = std::set<fsa_family>;

	/// provides a scope containing all FSA families
    extern fsa_scope all_fsa_families();

	/// convert an fsa scope to infinint
    extern infinint fsa_scope_to_infinint(const fsa_scope & val);

	/// convert an infinint to fsa_scape
    extern fsa_scope infinint_to_fsa_scope(const infinint & ref);

	/// convert an fsa scope to readable string
    extern std::string fsa_scope_to_string(bool saved, const fsa_scope & scope);

	/// @}

} // end of namespace

#endif
