pputil

package

v0.12.3 Latest Latest Go to latest Published: Oct 18, 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 FilterPublicHeaderFile(file FileEntry) bool
func IsHeaderFile(name string) bool
func ListFiles(dir string, recursive bool) iter.Seq2[FileEntry, error]
func ListFilterFiles(dir string, recursive bool, filter FilterFunc) iter.Seq2[FileEntry, error]
func ListIncludes(headerFile string, includeDirs []string) (includeFiles iter.Seq2[string, bool], err error)
func ScanIncludes(content []byte) iter.Seq[Include]
func TopHeaders(headerDir string, recursive, rel bool, includeDirs []string) (topHeaders []string, err error)
type FileEntry
type FilterFunc
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 FilterPublicHeaderFile ¶ added in v0.10.2

func FilterPublicHeaderFile(file FileEntry) bool

FilterPublicHeaderFile is a filter function that returns true if the given file is a public header file (i.e., it does not start with an underscore and has a header file extension).

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 ListFilterFiles ¶ added in v0.10.2

func ListFilterFiles(dir string, recursive bool, filter FilterFunc) iter.Seq2[FileEntry, error]

ListFilterFiles returns a sequence of files in the specified directory that satisfy the filter function. 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 ScanIncludes ¶ added in v0.10.2

func ScanIncludes(content []byte) iter.Seq[Include]

ScanIncludes scans the given content for `#include` directives and returns a sequence of Include objects.

It parses the file in a single pass, correctly handling `#include` directives with spaces or tabs between `#` and `include`, and ignoring any `#include` occurrences found within comments or string/character literals.

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 FilterFunc ¶ added in v0.10.2

type FilterFunc func(FileEntry) bool

FilterFunc defines a function type used to filter files 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

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