lldb/Core/FileSpecList.h

5 // This file is distributed under the University of Illinois Open Source
22 /// @brief A file collection class.
32     /// Initialize this object with an empty file list.
39     /// Initialize this object with a copy of the file list from \a rhs.
42     ///     A const reference to another file list object.
54     /// Replace the file list in this object with the file list from
58     ///     A file list object to copy.
69     /// Appends \a file to the end of the file list.
71     /// @param[in] file
72     ///     A new file to append to this file list.
75     Append (const FileSpec &file);
80     /// Appends \a file to the end of the file list if it doesn't
81     /// already exist in the file list.
83     /// @param[in] file
84     ///     A new file to append to this file list.
87     ///     \b true if the file was appended, \b false otherwise.
90     AppendIfUnique (const FileSpec &file);
93     /// Clears the file list.
99     /// Dumps the file list to the supplied stream pointer "s".
108     /// Find a file index.
110     /// Find the index of the file in the file spec list that matches
111     /// \a file starting \a idx entries into the file spec list.
114     ///     An index into the file list.
116     /// @param[in] file
117     ///     The file specification to search for.
123     ///     The index of the file that matches \a file if it is found,
127     FindFileIndex (size_t idx, const FileSpec &file, bool full) const;
130     /// Get file at index.
132     /// Gets a file from the file list. If \a idx is not a valid index,
133     /// an empty FileSpec object will be returned. The file objects
138     ///     An index into the file list.
149     /// Get file specification pointer at index.
151     /// Gets a file from the file list. The file objects that are
155     ///     An index into the file list.
186     /// Get the number of files in the file list.
189     ///     The number of files in the file spec list.
195     Insert (size_t idx, const FileSpec &file)
199             m_files.insert(m_files.begin() + idx, file);
204             m_files.push_back(file);
211     Replace (size_t idx, const FileSpec &file)
215             m_files[idx] = file;
235     typedef std::vector<FileSpec> collection;   ///< The collection type for the file list.