.. index:: pair: class; EE::System::PackFileIndex
.. _doxid-class_e_e_1_1_system_1_1_pack_file_index:

class EE::System::PackFileIndex
===============================

.. toctree::
	:hidden:

	struct_EE_System_PackFileIndex_Entry.rst
	struct_EE_System_PackFileIndex_IndexedDirectory.rst
	struct_EE_System_PackFileIndex_IndexedFile.rst

Overview
~~~~~~~~

Path index over the files of every open :ref:`Pack <doxid-class_e_e_1_1_system_1_1_pack>`. :ref:`More...<details-class_e_e_1_1_system_1_1_pack_file_index>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <packfileindex.hpp>
	
	class PackFileIndex: protected :ref:`EE::System::Container<doxid-class_e_e_1_1_system_1_1_container>` {
	public:
		// structs
	
		struct :ref:`Entry<doxid-struct_e_e_1_1_system_1_1_pack_file_index_1_1_entry>`;
		struct :ref:`IndexedDirectory<doxid-struct_e_e_1_1_system_1_1_pack_file_index_1_1_indexed_directory>`;
		struct :ref:`IndexedFile<doxid-struct_e_e_1_1_system_1_1_pack_file_index_1_1_indexed_file>`;

		// methods
	
		std::vector<std::string> :ref:`filesGetInPath<doxid-class_e_e_1_1_system_1_1_pack_file_index_1a9c3215167157de37e87b98b210ff81b5>`(std::string path);
		std::vector<:ref:`Entry<doxid-struct_e_e_1_1_system_1_1_pack_file_index_1_1_entry>`> :ref:`listDirectory<doxid-class_e_e_1_1_system_1_1_pack_file_index_1a7f3cb376441b4f5f7e75159fbf7d03ce>`(std::string path);
		:ref:`Pack<doxid-class_e_e_1_1_system_1_1_pack>`* :ref:`getPackFromFile<doxid-class_e_e_1_1_system_1_1_pack_file_index_1aea95aced135a4e4745edf5db1f620734>`(std::string path);
		:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`* :ref:`getFileFromPath<doxid-class_e_e_1_1_system_1_1_pack_file_index_1a22958f65b7c02744445c354eb1478ae1>`(const std::string& path);
		bool :ref:`extractFileToMemory<doxid-class_e_e_1_1_system_1_1_pack_file_index_1a5d9af177e98fb648ec2e613450c48c9d>`(const std::string& path, std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& data);
		bool :target:`fileExists<doxid-class_e_e_1_1_system_1_1_pack_file_index_1ac032fc3b6817dd68d5933e36aeddc710>`(const std::string& path);
		bool :target:`directoryExists<doxid-class_e_e_1_1_system_1_1_pack_file_index_1a3e7f2ab43d6f420f36835a49d46d0896>`(std::string path);
		:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` :ref:`getGeneration<doxid-class_e_e_1_1_system_1_1_pack_file_index_1acd6c131f14ba3bd820f5a9723f941c89>`() const;
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// methods
	
		T* :ref:`add<doxid-class_e_e_1_1_system_1_1_container_1af97b04b2ab6ec8d6d2e6e601ac0026f4>`(T* resource);
		bool :ref:`remove<doxid-class_e_e_1_1_system_1_1_container_1a4fa94818f1e9251f68ac4206031d8d74>`(T* resource);
		:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`count<doxid-class_e_e_1_1_system_1_1_container_1a743d7b6afa88128f9ca9644c6bce5062>`();

.. _details-class_e_e_1_1_system_1_1_pack_file_index:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Path index over the files of every open :ref:`Pack <doxid-class_e_e_1_1_system_1_1_pack>`.

Maps virtual paths such as "fonts/DejaVuSans.ttf" to the :ref:`Pack <doxid-class_e_e_1_1_system_1_1_pack>` that provides them. When several packs provide the same path, the most recently opened one wins. This is the storage behind the ``res://`` scheme of the eepp-vfs module (EE::VFS::ResourceProvider); it formerly was named VirtualFileSystem.

All methods are thread-safe.

Methods
-------

.. index:: pair: function; filesGetInPath
.. _doxid-class_e_e_1_1_system_1_1_pack_file_index_1a9c3215167157de37e87b98b210ff81b5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::vector<std::string> filesGetInPath(std::string path)



.. rubric:: Returns:

The full paths of the files directly inside path.

.. index:: pair: function; listDirectory
.. _doxid-class_e_e_1_1_system_1_1_pack_file_index_1a7f3cb376441b4f5f7e75159fbf7d03ce:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::vector<:ref:`Entry<doxid-struct_e_e_1_1_system_1_1_pack_file_index_1_1_entry>`> listDirectory(std::string path)



.. rubric:: Returns:

The files and directories directly inside path, sorted by name. Directories are implicit: they exist while any file below them exists. The root is "" (or "/").

.. index:: pair: function; getPackFromFile
.. _doxid-class_e_e_1_1_system_1_1_pack_file_index_1aea95aced135a4e4745edf5db1f620734:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Pack<doxid-class_e_e_1_1_system_1_1_pack>`* getPackFromFile(std::string path)



.. rubric:: Returns:

The pack that provides path, or nullptr. The pointer is only valid while the pack stays open.

.. index:: pair: function; getFileFromPath
.. _doxid-class_e_e_1_1_system_1_1_pack_file_index_1a22958f65b7c02744445c354eb1478ae1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>`* getFileFromPath(const std::string& path)



.. rubric:: Returns:

A new stream for path (owned by the caller), or nullptr.

.. index:: pair: function; extractFileToMemory
.. _doxid-class_e_e_1_1_system_1_1_pack_file_index_1a5d9af177e98fb648ec2e613450c48c9d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool extractFileToMemory(const std::string& path, std::vector<:ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>`>& data)

Extracts path into data.



.. rubric:: Returns:

False if the file is not indexed or extraction failed.

.. index:: pair: function; getGeneration
.. _doxid-class_e_e_1_1_system_1_1_pack_file_index_1acd6c131f14ba3bd820f5a9723f941c89:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` getGeneration() const



.. rubric:: Returns:

A counter that changes every time a pack is added or removed.