LibXR::RamFS::Dir Class Reference

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

#include <ramfs.hpp>

Inheritance diagram for LibXR::RamFS::Dir:

Collaboration diagram for LibXR::RamFS::Dir:

Public Member Functions
void	Add (File &file)
	添加直属文件节点 / Add a direct child file node
void	Add (Dir &dir)
	添加直属目录节点 / Add a direct child directory node
void	Add (Custom &custom)
	添加直属自定义节点 / Add a direct child custom node
FsNode *	FindNode (const char *name)
	查找直属子节点 / Find a direct child node
File *	FindFile (const char *name)
	查找直属文件 / Find a direct child file
File *	FindFileRev (const char *name)
	递归查找文件 / Find a file recursively
Dir *	FindDir (const char *name)
	查找直属目录，支持 "." 和 ".." / Find a direct child directory, supporting "." and ".."
Dir *	FindDirRev (const char *name)
	递归查找目录，支持 "." 和 ".." / Find a directory recursively, supporting "." and ".."
Custom *	FindCustom (const char *name)
	查找直属自定义节点 / Find a direct child custom node
Custom *	FindCustomRev (const char *name)
	递归查找自定义节点 / Find a custom node recursively
template<typename Func >
ErrorCode	Foreach (Func func)
	遍历直属子节点 / Iterate over direct child nodes
Public Member Functions inherited from LibXR::RamFS::FsNode
FsNodeType	GetNodeType () const
	获取节点类型 / Get the node type
const char *	GetName () const
	获取节点名称 / Get the node name

Private Member Functions
	Dir ()
	构造一个空目录壳 / Construct one empty directory shell
	Dir (const char *name)
	构造一个具名目录壳 / Construct one named directory shell
void	AddNode (FsNode &node)
	把一个节点挂到当前目录下 / Attach one node under the current directory
FsNode *	FindNodeByType (const char *name, FsNodeType type)
	在当前目录按类型查找直属节点 / Find one direct child node of a given type
FsNode *	FindNodeRevByType (const char *name, FsNodeType type)
	递归查找指定类型节点 / Find one node of a given type recursively

Private Attributes
Tree	rbt_
	当前目录直属子节点的名称索引树 / Name index tree of direct child nodes.

Friends
class	RamFS

Additional Inherited Members
Protected Member Functions inherited from LibXR::RamFS::FsNode
	FsNode (FsNodeType node_type)
	用指定节点类型构造基类部分 / Construct the base node with a given node type
	FsNode (const FsNode &other)
	拷贝构造节点基类部分 / Copy-construct the base-node portion
FsNode &	operator= (const FsNode &)=delete
Protected Attributes inherited from LibXR::RamFS::FsNode
const char *	name_ = nullptr
	节点名称缓冲区 / Retained node-name buffer.
FsNodeType	type_
	节点运行时类型 / Runtime node type.
Dir *	parent_ = nullptr
	父目录；根目录保持为空 / Parent directory; stays null for the root.
Tree::Node< FsNode * >	tree_node_
	当前节点挂进目录树时使用的树节点包装 / Tree node wrapper used when inserted into a directory tree.

Detailed Description

目录节点片段 / Directory-node fragment

RamFS 的目录节点片段 / Directory-node fragment of RamFS

目录节点，管理直属子节点 / Directory node that owns a child namespace

Definition at line 9 of file ramfs.hpp.

Constructor & Destructor Documentation

Dir() [1/2]

RamFS::Dir::Dir ( )

private

构造一个空目录壳 / Construct one empty directory shell

构造一个空目录壳 Construct one empty directory shell

Definition at line 110 of file ramfs.cpp.

: FsNode(FsNodeType::DIR), rbt_(RamFS::CompareStr) {}

Dir() [2/2]

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

explicitprivate

构造一个具名目录壳 / Construct one named directory shell

构造一个具名目录壳 Construct one named directory shell

Parameters

name	目录名称 / Directory name

Definition at line 117 of file ramfs.cpp.

: Dir() { this->name_ = DuplicateName(name); }

Member Function Documentation

Add() [1/3]

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

inline

添加直属自定义节点 / Add a direct child custom node

Parameters

custom

自定义节点 / Custom node

Definition at line 28 of file ramfs.hpp.

Add() [2/3]

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

inline

添加直属目录节点 / Add a direct child directory node

Parameters

dir	目录节点 / Directory node

Definition at line 22 of file ramfs.hpp.

Add() [3/3]

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

inline

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

Parameters

file	文件节点 / File node

Definition at line 16 of file ramfs.hpp.

AddNode()

void RamFS::Dir::AddNode ( FsNode & node )

private

把一个节点挂到当前目录下 / Attach one node under the current directory

把一个节点挂到当前目录下 Attach one node under the current directory

Parameters

node	待挂接节点 / Node to attach

Definition at line 124 of file ramfs.cpp.

{
  ASSERT(node.name_ != nullptr);
  ASSERT(FindNode(node.name_) == nullptr);
  node.parent_ = this;
  rbt_.Insert(node.tree_node_, node.name_);
}

FindCustom()

RamFS::Custom * RamFS::Dir::FindCustom

(

const char *

name

)

查找直属自定义节点 / Find a direct child custom node

查找直属自定义节点 Find one direct child custom node

Parameters

name	节点名称 / Node name

Returns

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

Parameters

name	节点名称 / Node name

Returns

自定义节点；未找到返回 nullptr Custom node, or nullptr if not found

Definition at line 298 of file ramfs.cpp.

{
  return static_cast<Custom*>(FindNodeByType(name, FsNodeType::CUSTOM));
}

FindCustomRev()

RamFS::Custom * RamFS::Dir::FindCustomRev

(

const char *

name

)

递归查找自定义节点 / Find a custom node recursively

递归查找自定义节点 Find one custom node recursively

Parameters

name	节点名称 / Node name

Returns

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

Parameters

name	节点名称 / Node name

Returns

自定义节点；未找到返回 nullptr Custom node, or nullptr if not found

Definition at line 310 of file ramfs.cpp.

{
  return static_cast<Custom*>(FindNodeRevByType(name, FsNodeType::CUSTOM));
}

FindDir()

RamFS::Dir * RamFS::Dir::FindDir

(

const char *

name

)

查找直属目录，支持 "." 和 ".." / Find a direct child directory, supporting "." and ".."

查找直属目录节点，支持 "." 和 ".." Find one direct child directory node, supporting "." and ".."

Parameters

name	目录名 / Directory name

Returns

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

Parameters

name	目录名称 / Directory name

Returns

目录节点；未找到返回 nullptr Directory node, or nullptr if not found

Definition at line 244 of file ramfs.cpp.

{
  if (name == nullptr)
  {
    return nullptr;
  }
 
  if (name[0] == '.' && name[1] == '\0')
  {
    return this;
  }
 
  if (name[0] == '.' && name[1] == '.' && name[2] == '\0')
  {
    return parent_;
  }
 
  return static_cast<Dir*>(FindNodeByType(name, FsNodeType::DIR));
}

FindDirRev()

RamFS::Dir * RamFS::Dir::FindDirRev

(

const char *

name

)

递归查找目录，支持 "." 和 ".." / Find a directory recursively, supporting "." and ".."

递归查找目录节点，支持 "." 和 ".." Find one directory node recursively, supporting "." and ".."

Parameters

name	目录名 / Directory name

Returns

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

Parameters

name	目录名称 / Directory name

Returns

目录节点；未找到返回 nullptr Directory node, or nullptr if not found

Definition at line 271 of file ramfs.cpp.

{
  if (name == nullptr)
  {
    return nullptr;
  }
 
  if (name[0] == '.' && name[1] == '\0')
  {
    return this;
  }
 
  if (name[0] == '.' && name[1] == '.' && name[2] == '\0')
  {
    return parent_;
  }
 
  return static_cast<Dir*>(FindNodeRevByType(name, FsNodeType::DIR));
}

FindFile()

RamFS::File * RamFS::Dir::FindFile

(

const char *

name

)

查找直属文件 / Find a direct child file

查找直属文件节点 Find one direct child file node

Parameters

name	文件名 / File name

Returns

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

Parameters

name	文件名 / File name

Returns

文件节点；未找到返回 nullptr File node, or nullptr if not found

Definition at line 220 of file ramfs.cpp.

{
  return static_cast<File*>(FindNodeByType(name, FsNodeType::FILE));
}

FindFileRev()

RamFS::File * RamFS::Dir::FindFileRev

(

const char *

name

)

递归查找文件 / Find a file recursively

递归查找文件节点 Find one file node recursively

Parameters

name	文件名 / File name

Returns

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

Parameters

name	文件名 / File name

Returns

文件节点；未找到返回 nullptr File node, or nullptr if not found

Definition at line 232 of file ramfs.cpp.

{
  return static_cast<File*>(FindNodeRevByType(name, FsNodeType::FILE));
}

FindNode()

RamFS::FsNode * RamFS::Dir::FindNode

(

const char *

name

)

查找直属子节点 / Find a direct child node

在当前目录查找直属子节点 Find one direct child node in the current directory

Parameters

name	节点名称 / Node name

Returns

子节点指针；未找到返回 nullptr / Child node pointer, or nullptr

Parameters

name	节点名称 / Node name

Returns

找到的节点；未找到返回 nullptr Matching node, or nullptr if not found

Definition at line 139 of file ramfs.cpp.

{
  if (name == nullptr)
  {
    return nullptr;
  }
 
  auto* node = rbt_.Search<FsNode*>(name);
  return node != nullptr ? node->data_ : nullptr;
}

FindNodeByType()

RamFS::FsNode * RamFS::Dir::FindNodeByType ( const char * name, FsNodeType type )

private

在当前目录按类型查找直属节点 / Find one direct child node of a given type

在当前目录按类型查找直属节点 Find one direct child node of a given type

Parameters

name	节点名称 / Node name
type	目标节点类型 / Desired node type

Returns

找到的节点；未找到返回 nullptr / Matching node, or nullptr

Parameters

name	节点名称 / Node name
type	目标节点类型 / Desired node type

Returns

找到的节点；未找到返回 nullptr Matching node, or nullptr if not found

Definition at line 158 of file ramfs.cpp.

{
  auto* ans = FindNode(name);
  if (ans == nullptr || ans->GetNodeType() != type)
  {
    return nullptr;
  }
  return ans;
}

FindNodeRevByType()

RamFS::FsNode * RamFS::Dir::FindNodeRevByType ( const char * name, FsNodeType type )

private

递归查找指定类型节点 / Find one node of a given type recursively

递归查找指定类型节点 Find one node of a given type recursively

Parameters

name	节点名称 / Node name
type	目标节点类型 / Desired node type

Returns

找到的节点；未找到返回 nullptr / Matching node, or nullptr

Parameters

name	节点名称 / Node name
type	目标节点类型 / Desired node type

Returns

找到的节点；未找到返回 nullptr Matching node, or nullptr if not found

Note

当前实现先检查直属节点；若未命中，再通过局部 visitor 继续深入直属子目录。 The current implementation first checks direct children; if that misses, it continues descending into direct child directories through a local visitor.

Definition at line 181 of file ramfs.cpp.

{
  auto* ans = FindNodeByType(name, type);
  if (ans != nullptr)
  {
    return ans;
  }
 
  struct FindNodeRevFn
  {
    const char* name_;
    FsNodeType type_;
    FsNode*& ans_;
 
    ErrorCode operator()(Tree::Node<FsNode*>& item)
    {
      auto* node = item.data_;
      if (node->GetNodeType() != FsNodeType::DIR)
      {
        return ErrorCode::OK;
      }
 
      ans_ = static_cast<Dir*>(node)->FindNodeRevByType(name_, type_);
      return ans_ != nullptr ? ErrorCode::FAILED : ErrorCode::OK;
    }
  };
 
  FindNodeRevFn find{name, type, ans};
  rbt_.Foreach<FsNode*>(find);
  return ans;
}

Foreach()

template<typename Func >

ErrorCode LibXR::RamFS::Dir::Foreach ( Func func )

inline

遍历直属子节点 / Iterate over direct child nodes

Template Parameters

Func	回调类型 / Callback type

Parameters

func	回调函数，返回非 OK 时停止遍历 / Callback; non-OK stops iteration

Returns

遍历结果 / Iteration result

Definition at line 88 of file ramfs.hpp.

Friends And Related Symbol Documentation

RamFS

friend class RamFS

friend

Definition at line 130 of file ramfs.hpp.

Field Documentation

rbt_

Tree LibXR::RamFS::Dir::rbt_

private

当前目录直属子节点的名称索引树 / Name index tree of direct child nodes.

Definition at line 128 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