README
¶
Cogent Core
Cogent Core is a free and open source framework for building powerful, fast, and cogent 2D and 3D apps that run on macOS, Windows, Linux, iOS, Android, and the Web with a single pure Go codebase, allowing you to Code Once, Run Everywhere. See the Cogent Core Website for more information, including extensive documentation and interactive running examples. The website itself is a Cogent Core app running on the web using wasm.
NOTE: Cogent Core is currently undergoing a period of significant development to make it easier to make powerful, fast, and cogent apps. As such, some of the information in this repository and on the Cogent Core website may be incorrect. Furthermore, there are ongoing breaking changes, so starting new apps with this framework is not recommended at this time; if you do, please be ready to adjust to any breaking changes. We are planning to make a v1 stable release in early June (see the v1 milestone).
Directories
¶
| Path | Synopsis |
|---|---|
|
cam
|
|
|
Package cli generates powerful CLIs from Go struct types and functions.
|
Package cli generates powerful CLIs from Go struct types and functions. |
|
Package cliview extends package cli by generating GUIs.
|
Package cliview extends package cli by generating GUIs. |
|
cmd
|
|
|
core
Command core provides command line tools for developing apps and libraries using the Cogent Core framework.
|
Command core provides command line tools for developing apps and libraries using the Cogent Core framework. |
|
core/cmd
Package cmd provides utilities for managing apps and packages that use the Cogent Core framework.
|
Package cmd provides utilities for managing apps and packages that use the Cogent Core framework. |
|
core/config
Package config contains the configuration structs for the Cogent Core tool.
|
Package config contains the configuration structs for the Cogent Core tool. |
|
core/generate
Package generate provides the generation of useful methods, variables, and constants for Cogent Core code.
|
Package generate provides the generation of useful methods, variables, and constants for Cogent Core code. |
|
core/mobile
Gomobile is a tool for building and running mobile apps written in Go.
|
Gomobile is a tool for building and running mobile apps written in Go. |
|
core/mobile/binres
Package binres implements encoding and decoding of android binary resources.
|
Package binres implements encoding and decoding of android binary resources. |
|
core/mobile/sdkpath
Package sdkpath provides functions for locating the Android SDK.
|
Package sdkpath provides functions for locating the Android SDK. |
|
Package colors provides named colors, utilities for manipulating colors, and Material Design 3 color schemes, palettes, and keys in Go.
|
Package colors provides named colors, utilities for manipulating colors, and Material Design 3 color schemes, palettes, and keys in Go. |
|
gradient
Package gradient provides linear, radial, and conic color gradients.
|
Package gradient provides linear, radial, and conic color gradients. |
|
matcolor
Package matcolor provides support for creating Material Design 3 color schemes and palettes.
|
Package matcolor provides support for creating Material Design 3 color schemes and palettes. |
|
Package core provides the core GUI functionality of Cogent Core.
|
Package core provides the core GUI functionality of Cogent Core. |
|
Package cursors provides Go constant names for cursors as SVG files.
|
Package cursors provides Go constant names for cursors as SVG files. |
|
cursorimg
Package cursorimg provides the cached rendering of SVG cursors to images.
|
Package cursorimg provides the cached rendering of SVG cursors to images. |
|
Package difflib is a partial port of Python difflib module.
|
Package difflib is a partial port of Python difflib module. |
|
bytes
Package bytes is a partial port of Python difflib module for bytes.
|
Package bytes is a partial port of Python difflib module for bytes. |
|
Package enums provides common interfaces for enums and bit flag enums and utilities for using them
|
Package enums provides common interfaces for enums and bit flag enums and utilities for using them |
|
cmd/enumgen
Package main provides the actual command line implementation of the enumgen library.
|
Package main provides the actual command line implementation of the enumgen library. |
|
enumgen
Package enumgen provides functions for generating enum methods for enum types.
|
Package enumgen provides functions for generating enum methods for enum types. |
|
Package errors provides a set of error handling helpers, extending the standard library errors package.
|
Package errors provides a set of error handling helpers, extending the standard library errors package. |
|
key
Package key defines an event for physical keyboard keys, for the Cogent Core GUI system.
|
Package key defines an event for physical keyboard keys, for the Cogent Core GUI system. |
|
examples
|
|
|
async
Command async demonstrates async updating in Cogent Core.
|
Command async demonstrates async updating in Cogent Core. |
|
Package exec provides an easy way to execute commands, improving the ease-of-use and error handling of the standard library os/exec package.
|
Package exec provides an easy way to execute commands, improving the ease-of-use and error handling of the standard library os/exec package. |
|
Package fileinfo manages file information and categorizes file types; it is the single, consolidated place where file info, mimetypes, and filetypes are managed in Cogent Core.
|
Package fileinfo manages file information and categorizes file types; it is the single, consolidated place where file info, mimetypes, and filetypes are managed in Cogent Core. |
|
Package generate provides utilities for building code generators in Go.
|
Package generate provides utilities for building code generators in Go. |
|
gox
|
|
|
atomctr
Package atomctr implements basic atomic int64 counter
|
Package atomctr implements basic atomic int64 counter |
|
bools
Package bools provides functions and interfaces for interacting with bool values.
|
Package bools provides functions and interfaces for interacting with bool values. |
|
datasize
Package datasize provides a data size type and constants.
|
Package datasize provides a data size type and constants. |
|
dirs
Package dirs provides various utility functions in dealing with directories such as a list of all the files with a given (set of) extensions and finding paths within the Go source directory (GOPATH, etc)
|
Package dirs provides various utility functions in dealing with directories such as a list of all the files with a given (set of) extensions and finding paths within the Go source directory (GOPATH, etc) |
|
elide
Package elide provides basic text eliding functions.
|
Package elide provides basic text eliding functions. |
|
indent
Package indent provides trivial indentation generation methods: Tabs, Spaces, and Indent with a selector.
|
Package indent provides trivial indentation generation methods: Tabs, Spaces, and Indent with a selector. |
|
nptime
Package nptime provides a non-pointer version of the time.Time struct that does not have the location pointer information that time.Time has, which is more efficient from a memory management perspective, in cases where you have a lot of time values being kept: https://segment.com/blog/allocation-efficiency-in-high-performance-go-services/
|
Package nptime provides a non-pointer version of the time.Time struct that does not have the location pointer information that time.Time has, which is more efficient from a memory management perspective, in cases where you have a lot of time values being kept: https://segment.com/blog/allocation-efficiency-in-high-performance-go-services/ |
|
option
Package option provides optional (nullable) types.
|
Package option provides optional (nullable) types. |
|
runes
Package runes provides a small subset of functions that are found in strings, bytes standard packages, for rune slices.
|
Package runes provides a small subset of functions that are found in strings, bytes standard packages, for rune slices. |
|
tolassert
Package tolassert provides functions for asserting the equality of numbers with tolerance (in other words, it checks whether numbers are about equal).
|
Package tolassert provides functions for asserting the equality of numbers with tolerance (in other words, it checks whether numbers are about equal). |
|
Package htmlview converts HTML and MD into Cogent Core widget trees.
|
Package htmlview converts HTML and MD into Cogent Core widget trees. |
|
Package icons provides Go constant names for Material Design Symbols as SVG files.
|
Package icons provides Go constant names for Material Design Symbols as SVG files. |
|
Package iox provides boilerplate wrapper functions for the Go standard io functions to Read, Open, Write, and Save, with implementations for commonly used encoding formats.
|
Package iox provides boilerplate wrapper functions for the Go standard io functions to Read, Open, Write, and Save, with implementations for commonly used encoding formats. |
|
Package jsfs provides a Node.js style filesystem API in Go that can be used to allow os functions to work on wasm.
|
Package jsfs provides a Node.js style filesystem API in Go that can be used to allow os functions to work on wasm. |
|
Package keymap implements maps from keyboard shortcuts to semantic GUI keyboard functions.
|
Package keymap implements maps from keyboard shortcuts to semantic GUI keyboard functions. |
|
Package logx implements structured log handling and provides global log and print verbosity and color options.
|
Package logx implements structured log handling and provides global log and print verbosity and color options. |
|
math32 is our version of the G3N math32 32-bit, 3D rendering-based math library.
|
math32 is our version of the G3N math32 32-bit, 3D rendering-based math library. |
|
Package mergefs provides support for merging multiple filesystems together.
|
Package mergefs provides support for merging multiple filesystems together. |
|
Package mimedata defines MIME data support used in clipboard and drag-and-drop functions in the Cogent Core GUI.
|
Package mimedata defines MIME data support used in clipboard and drag-and-drop functions in the Cogent Core GUI. |
|
package ordmap implements an ordered map that retains the order of items added to a slice, while also providing fast key-based map lookup of items, using the Go 1.18 generics system.
|
package ordmap implements an ordered map that retains the order of items added to a slice, while also providing fast key-based map lookup of items, using the Go 1.18 generics system. |
|
Package pages provides an easy way to make content-focused sites consisting of Markdown, HTML, and Cogent Core pages.
|
Package pages provides an easy way to make content-focused sites consisting of Markdown, HTML, and Cogent Core pages. |
|
wpath
Package wpath handles pages paths.
|
Package wpath handles pages paths. |
|
Package Paint is the paint package for the Cogent Core render library.
|
Package Paint is the paint package for the Cogent Core render library. |
|
Package parse is the top-level package for the Cogent Core parsing system.
|
Package parse is the top-level package for the Cogent Core parsing system. |
|
lexer
Package lexer provides all the lexing functions that transform text into lexical tokens, using token types defined in the token package.
|
Package lexer provides all the lexing functions that transform text into lexical tokens, using token types defined in the token package. |
|
lsp
Package lsp contains types for the Language Server Protocol LSP: https://microsoft.github.io/language-server-protocol/specification and mappings from these elements into the token.Tokens types which are used internally in parse.
|
Package lsp contains types for the Language Server Protocol LSP: https://microsoft.github.io/language-server-protocol/specification and mappings from these elements into the token.Tokens types which are used internally in parse. |
|
parser
Package parse does the parsing stage after lexing
|
Package parse does the parsing stage after lexing |
|
suplangs
Package suplangs includes all the supported languages for parse -- need to import this package to get those all included in a given target
|
Package suplangs includes all the supported languages for parse -- need to import this package to get those all included in a given target |
|
syms
Package syms defines the symbols and their properties that are accumulated from a parsed file, and are then used for e.g., completion lookup, etc.
|
Package syms defines the symbols and their properties that are accumulated from a parsed file, and are then used for e.g., completion lookup, etc. |
|
token
Package token defines a complete set of all lexical tokens for any kind of language! It is based on the alecthomas/chroma / pygments lexical tokens plus all the more detailed tokens needed for actually parsing languages
|
Package token defines a complete set of all lexical tokens for any kind of language! It is based on the alecthomas/chroma / pygments lexical tokens plus all the more detailed tokens needed for actually parsing languages |
|
Package profile provides basic but effective profiling of targeted functions or code sections, which can often be more informative than generic cpu profiling.
|
Package profile provides basic but effective profiling of targeted functions or code sections, which can often be more informative than generic cpu profiling. |
|
Package reflectx provides a collection of helpers for the reflect package in the Go standard library.
|
Package reflectx provides a collection of helpers for the reflect package in the Go standard library. |
|
Package scan provides an anti-aliasing 2-D rasterizer, which is based on the larger Freetype suite of font-related packages, but the raster package is not specific to font rasterization, and can be used standalone without any other Freetype package.
|
Package scan provides an anti-aliasing 2-D rasterizer, which is based on the larger Freetype suite of font-related packages, but the raster package is not specific to font rasterization, and can be used standalone without any other Freetype package. |
|
Package spell provides functions for spell check and correction.
|
Package spell provides functions for spell check and correction. |
|
Package strcase provides functions for manipulating the case of strings (CamelCase, kebab-case, snake_case, Sentence case, etc).
|
Package strcase provides functions for manipulating the case of strings (CamelCase, kebab-case, snake_case, Sentence case, etc). |
|
Package GiSt contains the style structures for the Cogent Core GUI framework.
|
Package GiSt contains the style structures for the Cogent Core GUI framework. |
|
Package svg provides SVG rendering classes, I/O parsing: full SVG rendering
|
Package svg provides SVG rendering classes, I/O parsing: full SVG rendering |
|
Package system provides a Go operating system interface framework to support events, window management, and other OS-specific functionality needed for full GUI support.
|
Package system provides a Go operating system interface framework to support events, window management, and other OS-specific functionality needed for full GUI support. |
|
driver/base
Package base provides base driver types that platform-specific drivers can extend to implement interfaces defined in package system.
|
Package base provides base driver types that platform-specific drivers can extend to implement interfaces defined in package system. |
|
driver/mobile/mobileinit
Package mobileinit contains common initialization logic for mobile platforms that is relevant to both all-Go apps and gobind-based apps.
|
Package mobileinit contains common initialization logic for mobile platforms that is relevant to both all-Go apps and gobind-based apps. |
|
driver/offscreen
Package offscreen provides placeholder implementations of system interfaces to allow for offscreen testing and capturing of apps.
|
Package offscreen provides placeholder implementations of system interfaces to allow for offscreen testing and capturing of apps. |
|
driver/web
Package web implements system interfaces on the web through WASM
|
Package web implements system interfaces on the web through WASM |
|
histyle
Package histyle provides syntax highlighting styles; it is based on github.com/alecthomas/chroma, which in turn was based on the python pygments package.
|
Package histyle provides syntax highlighting styles; it is based on github.com/alecthomas/chroma, which in turn was based on the python pygments package. |
|
Package tree provides a powerful and extensible tree system, centered on the core Node interface.
|
Package tree provides a powerful and extensible tree system, centered on the core Node interface. |
|
Package types provides type information for Go types, methods, and functions.
|
Package types provides type information for Go types, methods, and functions. |
|
cmd/typegen
Command typgen provides the generation of type information for Go types, methods, and functions.
|
Command typgen provides the generation of type information for Go types, methods, and functions. |
|
typegen
Package typgen provides the generation of type information for Go types, methods, and functions.
|
Package typgen provides the generation of type information for Go types, methods, and functions. |
|
Package undo supports generic undo / redo functionality, using an efficient diff of string-valued state representation of a 'document' being edited which can be JSON or XML or actual text -- whatever.
|
Package undo supports generic undo / redo functionality, using an efficient diff of string-valued state representation of a 'document' being edited which can be JSON or XML or actual text -- whatever. |
|
Package Units supports full range of CSS-style length units (em, px, dp, etc)
|
Package Units supports full range of CSS-style length units (em, px, dp, etc) |
|
Package vcs provides a more complete version control system (ex: git) interface, building on https://github.com/Masterminds/vcs.
|
Package vcs provides a more complete version control system (ex: git) interface, building on https://github.com/Masterminds/vcs. |
|
Package vgpu implements a convenient interface to the Vulkan GPU-based graphics and compute framework, in Go, using the https://github.com/goki/vulkan Go bindings.
|
Package vgpu implements a convenient interface to the Vulkan GPU-based graphics and compute framework, in Go, using the https://github.com/goki/vulkan Go bindings. |
|
vkinit
package vkinit handles loading and initialization of Vulkan without any dependency upon glfw
|
package vkinit handles loading and initialization of Vulkan without any dependency upon glfw |
|
vshape
vshape provides a library of 3D shapes, built from indexed triangle meshes, which can be added together in `ShapeGroup` lists.
|
vshape provides a library of 3D shapes, built from indexed triangle meshes, which can be added together in `ShapeGroup` lists. |
|
Package video implements a video player widget in Cogent Core.
|
Package video implements a video player widget in Cogent Core. |
|
Package views allows you to view and edit Go data in the GUI using reflection.
|
Package views allows you to view and edit Go data in the GUI using reflection. |
|
Package xyz provides a 3D scenegraph for the Cogent Core GUI framework.
|
Package xyz provides a 3D scenegraph for the Cogent Core GUI framework. |
|
io/obj
Package obj is used to parse the Wavefront OBJ file format (*.obj), including associated materials (*.mtl).
|
Package obj is used to parse the Wavefront OBJ file format (*.obj), including associated materials (*.mtl). |
|
Package xyzview provides a GUI view for a 3D xyz scene.
|
Package xyzview provides a GUI view for a 3D xyz scene. |
Click to show internal directories.
Click to hide internal directories.