FileManager.h

Go to the documentation of this file.

/*$!{
* Aurora Clang AST Viewer (ACAV)
* 
* Copyright (c) 2026 Min Liu
* Copyright (c) 2026 Michael David Adams
* 
* SPDX-License-Identifier: GPL-2.0-or-later
* 
* 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, see <https://www.gnu.org/licenses/>.
}$!*/

#pragma once
 
#include <cstddef>
#include <mutex>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
namespace acav {

using FileID = std::size_t;

class FileManager {
public:
  static constexpr FileID InvalidFileID = 0; 
 
  FileManager() = default;
  ~FileManager() = default;
 
  FileManager(const FileManager &) = delete;
  FileManager &operator=(const FileManager &) = delete;
  FileManager(FileManager &&) = delete;
  FileManager &operator=(FileManager &&) = delete;

  FileID registerFile(std::string_view filePath);

  std::optional<FileID> tryGetFileId(std::string_view filePath) const;

  std::string_view getFilePath(FileID id) const;

  std::size_t getRefCount(FileID id) const;

  std::size_t getRegisteredFileCount() const;

  bool isValidFileId(FileID id) const;
 
private:
  // Internal file record
  struct FileRecord {
    std::string path;        // Normalized canonical path
    std::size_t refCount = 0; // Number of times registered
  };
 
  // Normalize file path to canonical form
  // Handles: relative paths, symbolic links, ".." and "." components
  // Returns: Canonical absolute path as string
  std::string normalizePath(std::string_view filePath) const;
 
  mutable std::mutex mutex_;                      // Thread-safety lock
  std::vector<FileRecord> files_;                 // Indexed by FileID - 1
  std::unordered_map<std::string, FileID> pathToId_; // Fast lookup cache
};
 
} // namespace acav