轻量级内存文件系统 / Lightweight in-memory file system More...

#include <ramfs.hpp>

Collaboration diagram for LibXR::RamFS:

Classes
class	Custom
	自定义节点片段 / Custom-node fragment More...

class	Dir
	目录节点片段 / Directory-node fragment More...

class	File
	文件节点片段 / File-node fragment More...

class	FsNode
	节点基类片段 / Base-node fragment More...

Public Types
enum class	FsNodeType : uint8_t { FILE , DIR , CUSTOM }
	文件系统节点类型 / File-system node type More...

Public Member Functions
	RamFS (const char *name="ramfs")
	构造 RamFS，并创建根目录和 `bin` 目录 / Construct RamFS with root and `bin` directories

void	Add (File &file)
	添加文件节点到根目录 / Add a file node to the root directory

void	Add (Dir &dir)
	添加目录节点到根目录 / Add a directory node to the root directory

void	Add (Custom &custom)
	添加自定义节点到根目录 / Add a custom node to the root directory

File *	FindFile (const char *name)
	从整个 RamFS 递归查找文件 / Find a file recursively from the RamFS root

Dir *	FindDir (const char *name)
	从整个 RamFS 递归查找目录 / Find a directory recursively from the RamFS root

Custom *	FindCustom (const char *name)
	从整个 RamFS 递归查找自定义节点 / Find a custom node recursively from the RamFS root

Static Public Member Functions
template<typename DataType >
static File	CreateFile (const char *name, DataType &raw)
	工厂与根入口片段 / Factory and root-entry fragment

template<typename ArgType >
static File	CreateFile (const char name, int(exec)(ArgType arg, int argc, char **argv), ArgType &&arg)
	创建可执行文件 / Create an executable file

template<typename ArgType >
static File	CreateCommand (const char name, int(exec)(ArgType arg, int argc, char **argv), ArgType &&arg)
	创建命令兼容入口，返回可执行文件 / Create a command-compatible executable file

static File	CreateCommand (const char name, int(exec)(int argc, char **argv))
	创建不需要执行上下文的命令 / Create a command that needs no execution context

static Dir	CreateDir (const char *name)
	创建目录节点 / Create a directory node

Public Attributes
Dir	root_

Dir	bin_
	预留的可执行文件目录 / Reserved executable-file directory.

Detailed Description

轻量级内存文件系统 / Lightweight in-memory file system

RamFS 组织外部内存文件、可执行文件、目录和自定义节点 / RamFS organizes external-memory files, executable files, directories, and custom nodes. 文件数据由调用方持有 / File payload storage is owned by the caller.

Definition at line 22 of file ramfs.hpp.

Member Enumeration Documentation

◆ FsNodeType

enum class LibXR::RamFS::FsNodeType : uint8_t

strong

文件系统节点类型 / File-system node type

Enumerator
FILE	文件 / File
DIR	目录 / Directory
CUSTOM	用户自定义节点 / User-defined node

Definition at line 37 of file ramfs.hpp.

  {
    FILE,    
    DIR,     
    CUSTOM,  
  };

Constructor & Destructor Documentation

◆ RamFS()

RamFS::RamFS ( const char * name = "ramfs" )

构造 RamFS，并创建根目录和 bin 目录 / Construct RamFS with root and bin directories

构造 RamFS，并挂接根目录下的 bin 目录 Construct RamFS and attach the bin directory under the root

Parameters

name	根目录名称 / Root directory name

Note: 包含动态内存分配 / Contains dynamic memory allocation

Parameters

name	根目录名称 / Root directory name

Definition at line 10 of file ramfs.cpp.

10: root_(name), bin_("bin") { root_.Add(bin_); }

LibXR::RamFS::Dir::Add

void Add(File &file)

添加直属文件节点 / Add a direct child file node

Definition ramfs.hpp:16

LibXR::RamFS::bin_

Dir bin_

预留的可执行文件目录 / Reserved executable-file directory.

Definition ramfs.hpp:177

LibXR::RamFS::root_

Dir root_

Definition ramfs.hpp:175

Member Function Documentation

◆ Add() [1/3]

void LibXR::RamFS::Add ( Custom & custom )

inline

添加自定义节点到根目录 / Add a custom node to the root directory

Parameters

custom 自定义节点 / Custom node

Definition at line 151 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

◆ Add() [2/3]

void LibXR::RamFS::Add ( Dir & dir )

inline

添加目录节点到根目录 / Add a directory node to the root directory

Parameters

dir	目录节点 / Directory node

Definition at line 145 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

◆ Add() [3/3]

void LibXR::RamFS::Add ( File & file )

inline

添加文件节点到根目录 / Add a file node to the root directory

Parameters

file	文件节点 / File node

Note: RamFS 只保存节点地址，节点必须是在整个运行期内有效的左值； Add(RamFS::CreateCommand(...)) 传入临时对象会留下悬空指针，因此不接受右值。 RamFS only stores the node address, so the node must be an lvalue that lives for the whole run; passing a temporary from CreateCommand(...) would leave a dangling pointer, which is why rvalues are not accepted.

Definition at line 139 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

◆ CreateCommand() [1/2]

template<typename ArgType >

static File LibXR::RamFS::CreateCommand	(	const char *	name,
		int(*	exec )(ArgType arg, int argc, char **argv),
		ArgType &&	arg )

inlinestatic

创建命令兼容入口，返回可执行文件 / Create a command-compatible executable file

Template Parameters

ArgType 执行上下文参数类型 / Execution context argument type

Parameters

name	文件名 / File name
exec	执行函数 / Execution function
arg	执行上下文参数 / Execution context argument

Returns: 可执行文件节点 / Executable file node

Note: 包含动态内存分配 / Contains dynamic memory allocation; 运行期持久化语义与上面的 executable factory 相同；命令块按当前设计默认常驻。 This follows the same lifetime-retained semantics as the executable factory above; command blocks are intentionally retained by design.

Definition at line 92 of file ramfs.hpp.

93 :

◆ CreateCommand() [2/2]

static File LibXR::RamFS::CreateCommand	(	const char *	name,
		int(*	exec )(int argc, char **argv) )

inlinestatic

创建不需要执行上下文的命令 / Create a command that needs no execution context

Parameters

name	文件名 / File name
exec	命令函数，参数为 argc 和 argv / Command function taking argc and argv

Returns: 可执行文件节点 / Executable file node

Note: 等价于带执行上下文的写法，上下文为函数本身；不再需要 CreateCommand<void*>(name, [](void*, int, char**) {...}, nullptr)。 Equivalent to the form with an execution context, the context being the function itself; CreateCommand<void*>(name, [](void*, int, char**) {...}, nullptr) is no longer needed.; 包含动态内存分配，命令块按当前设计默认常驻。 Contains dynamic memory allocation; the command block is retained by design.

Definition at line 112 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

◆ CreateDir()

static Dir LibXR::RamFS::CreateDir ( const char * name )

inlinestatic

创建目录节点 / Create a directory node

Parameters

name	目录名称 / Directory name

Returns: 目录节点 / Directory node

Note: 包含动态内存分配 / Contains dynamic memory allocation

Definition at line 127 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

◆ CreateFile() [1/2]

template<typename DataType >

static File LibXR::RamFS::CreateFile	(	const char *	name,
		DataType &	raw )

inlinestatic

工厂与根入口片段 / Factory and root-entry fragment

RamFS 的工厂与根入口片段 / Factory and root-entry fragment of RamFS

创建引用外部数据的文件 / Create a file referencing external data

Template Parameters

DataType 外部数据类型 / External data type

Parameters

name	文件名 / File name
raw	外部数据引用 / External data reference

Returns: 文件节点 / File node

Note: 包含动态内存分配 / Contains dynamic memory allocation

Definition at line 15 of file ramfs.hpp.

{
 public:
  RamFS(const char* name = "ramfs");
 

◆ CreateFile() [2/2]

template<typename ArgType >

static File LibXR::RamFS::CreateFile	(	const char *	name,
		int(*	exec )(ArgType arg, int argc, char **argv),
		ArgType &&	arg )

inlinestatic

创建可执行文件 / Create an executable file

Template Parameters

ArgType 执行上下文参数类型 / Execution context argument type

Parameters

name	文件名 / File name
exec	执行函数 / Execution function
arg	执行上下文参数 / Execution context argument

Returns: 可执行文件节点 / Executable file node

Note: 包含动态内存分配 / Contains dynamic memory allocation; 可执行块按当前 RamFS 设计属于初始化后常驻状态；当前实现不提供运行期回收路径。 Executable blocks are retained for startup / lifetime registration in the current RamFS design; the implementation does not provide a runtime reclamation path for them.

Definition at line 51 of file ramfs.hpp.

                      : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:

◆ FindCustom()

Custom * LibXR::RamFS::FindCustom ( const char * name )

inline

从整个 RamFS 递归查找自定义节点 / Find a custom node recursively from the RamFS root

Parameters

name	节点名称 / Node name

Returns: 自定义节点指针；未找到返回 nullptr / Custom node pointer, or nullptr

Definition at line 173 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

◆ FindDir()

Dir * LibXR::RamFS::FindDir ( const char * name )

inline

从整个 RamFS 递归查找目录 / Find a directory recursively from the RamFS root

Parameters

name	目录名 / Directory name

Returns: 目录指针；未找到返回 nullptr / Directory pointer, or nullptr

Definition at line 165 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

◆ FindFile()

File * LibXR::RamFS::FindFile ( const char * name )

inline

从整个 RamFS 递归查找文件 / Find a file recursively from the RamFS root

Parameters

name	文件名 / File name

Returns: 文件指针；未找到返回 nullptr / File pointer, or nullptr

Definition at line 158 of file ramfs.hpp.

{
class RamFS
{
 public:
  RamFS(const char* name = "ramfs");
 
  enum class FsNodeType : uint8_t
  {
    FILE,    
    DIR,     
    CUSTOM,  
  };
 
  class Dir;
 
 private:
  using Tree = RBTree<const char*>;
 
  enum class FileType : uint8_t
  {
    READ_ONLY,   
    READ_WRITE,  
    EXEC,        
  };
 
  static int CompareStr(const char* const& a, const char* const& b);
 
 public:
#include "fs_node.hpp"
#include "file.hpp"
#include "custom.hpp"
#include "dir.hpp"
#include "factory.hpp"
 
 private:
  static char* DuplicateName(const char* name);
};
}  // namespace LibXR

Member Data Documentation

◆ bin_

Dir LibXR::RamFS::bin_

预留的可执行文件目录 / Reserved executable-file directory.

Definition at line 177 of file ramfs.hpp.

◆ root_

Dir LibXR::RamFS::root_

根目录；所有外部 Add()/Find*() 默认都从这里进入 / Root directory; all external Add()/Find*() entry through here.

Definition at line 175 of file ramfs.hpp.

The documentation for this class was generated from the following files:

src/middleware/ramfs/ramfs.hpp
src/middleware/ramfs/ramfs.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ FsNodeType

Constructor & Destructor Documentation

◆ RamFS()

Member Function Documentation

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ CreateCommand() [1/2]

◆ CreateCommand() [2/2]

◆ CreateDir()

◆ CreateFile() [1/2]

◆ CreateFile() [2/2]

◆ FindCustom()

◆ FindDir()

◆ FindFile()

Member Data Documentation

◆ bin_

◆ root_