pputil

package

v0.9.3 Latest Latest Go to latest Published: Oct 2, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/goplus/llcppg

Links

Documentation ¶

Index ¶

func IsHeaderFile(name string) bool
func ListFiles(dir string, recursive bool) iter.Seq2[FileEntry, error]
func ListIncludes(headerFile string, includeDirs []string) (includeFiles iter.Seq2[string, bool], err error)
func LoadIncludes(headerFile string) (includes iter.Seq[Include], err error)
func TopHeaders(headerDir string, recursive, rel bool, includeDirs []string) (topHeaders []string, err error)
type FileEntry
type Include
- func (p *Include) Search(workDir string, searchDirs []string) (found string, ok bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IsHeaderFile ¶

func IsHeaderFile(name string) bool

IsHeaderFile checks if the given file name has a header file extension.

func ListFiles ¶

func ListFiles(dir string, recursive bool) iter.Seq2[FileEntry, error]

ListFiles returns a sequence of files in the specified directory. If recursive is true, it includes files in subdirectories as well.

func ListIncludes ¶

func ListIncludes(headerFile string, includeDirs []string) (includeFiles iter.Seq2[string, bool], err error)

ListIncludes lists the include files for the specified header file. It returns a sequence of include file paths and a boolean indicating whether the file was found. The include file path is the resolved path when ok is true, and the raw include filename otherwise.

func LoadIncludes ¶

func LoadIncludes(headerFile string) (includes iter.Seq[Include], err error)

LoadIncludes loads the include directives from the specified header file. It returns a sequence of Include objects.

func TopHeaders ¶

func TopHeaders(headerDir string, recursive, rel bool, includeDirs []string) (topHeaders []string, err error)

TopHeaders returns the top-level header files in the specified directory.

Types ¶

type FileEntry ¶

type FileEntry struct {
	Path string
	os.DirEntry
}

FileEntry represents a file entry in a directory.

type Include ¶

type Include struct {
	Filename string
	Quote    bool
}

Include represents a C/C++ include directive.

func (*Include) Search ¶

func (p *Include) Search(workDir string, searchDirs []string) (found string, ok bool)

Search searches for the include file in the specified directories. Note: `found` is the resolved path only when ok is true, and the raw include name otherwise.

Source Files ¶

View all Source files

pputil.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL