filecat

package
v2.0.0-dev0.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 31, 2023 License: BSD-3-Clause Imports: 19 Imported by: 0

Documentation

Overview

Package filecat categorizes file types -- it is the single, consolidated place where mimetypes and filetypes etc are managed in GoGi / GoKi.

This whole space is a bit of a heterogenous mess -- most file types we care about are not registered on the official iana registry, which seems mainly to have paid registrations in application/ category, and doesn't have any of the main programming languages etc.

The official Go std library support depends on different platform libraries and mac doesn't have one, so it has very limited support

So we sucked it up and made a full list of all the major file types that we really care about and also provide a broader category-level organization that is useful for functionally organizing / operating on files.

As fallback, we are using both of the go packages developed by others: github.com/gabriel-vasile/mimetype github.com/h2non/filetype (which constrained our package name to not be either of those two)

Index

Constants

View Source 
const (
	TextPlain = "text/plain"
	DataJson  = "application/json"
	DataXml   = "application/xml"
	DataCsv   = "text/csv"
)

These are the super high-frequency used mime types, to have very quick const level support

Variables

View Source 
var AvailMimes map[string]MimeType

AvailMimes is the full list (as a map from mimetype) of available defined mime types built from StdMimes (compiled in) and then CustomMimes can override

View Source 
var CustomMimes []MimeType

CustomMimes can be set by other apps to contain custom mime types that go beyond what is in the standard ones, and can also redefine and override the standard one

View Source 
var ExtMimeMap = map[string]string{}

ExtMimeMap is the map from extension to mime type, built from AvailMimes

View Source 
var FileInfoProps = ki.Props{
	"CtxtMenu": ki.PropSlice{
		{"Duplicate", ki.Props{
			"desc":    "Duplicate this file or folder",
			"confirm": true,
		}},
		{"Delete", ki.Props{
			"desc":    "Ok to delete this file or folder?  This is not undoable and is not moving to trash / recycle bin",
			"confirm": true,
		}},
		{"Rename", ki.Props{
			"desc": "Rename file to new file name",
			"Args": ki.PropSlice{
				{"New Name", ki.Props{
					"default-field": "Name",
				}},
			},
		}},
	},
}
View Source 
var StdMimes = []MimeType{}/* 284 elements not displayed */

StdMimes is the full list of standard mime types compiled into our code various other maps etc are constructed from it. When there are multiple types associated with the same real type, pick one to be the canonical one and give it, and *only* it, the extensions!

View Source 
var SupportedMimes map[Supported]MimeType

SupportedMimes maps from the support type into the MimeType info for each supported file type -- the supported MimeType may be just one of multiple that correspond to the supported type -- it should be first in list and have extensions defined

Functions

func CopyFile 

func CopyFile(dst, src string, perm os.FileMode) error

CopyFile copies the contents from src to dst atomically. If dst does not exist, CopyFile creates it with permissions perm. If the copy fails, CopyFile aborts and dst is preserved.

func FileNames 

func FileNames(d os.File, names *[]string) (err error)

FileNames recursively adds fullpath filenames within the starting directory to the "names" slice. Directory names within the starting directory are not added.

func IsMatch 

func IsMatch(targ, typ Supported) bool

IsMatch returns true if given file type matches target type, which could be any of the Any options

func IsMatchList 

func IsMatchList(targs []Supported, typ Supported) bool

IsMatchList returns true if given file type matches any of a list of targets if list is empty, then always returns true

func MergeAvailMimes 

func MergeAvailMimes()

MergeAvailMimes merges the StdMimes and CustomMimes into AvailMimes if CustomMimes is updated, then this should be called -- initially it just has StdMimes. It also builds the ExtMimeMap to map from extension to mime type and SupportedMimes map of supported file types onto their full mime type entry

func MimeFromFile 

func MimeFromFile(fname string) (mtype, ext string, err error)

MimeFromFile gets mime type from file, using Gabriel Vasile's mimetype package, mime.TypeByExtension, the chroma syntax highlighter, CustomExtMimeMap, and finally FileExtMimeMap. Use the mimetype package's extension mechanism to add further content-based matchers as needed, and set CustomExtMimeMap to your own map or call AddCustomExtMime for extension-based ones.

func MimeNoChar 

func MimeNoChar(mime string) string

MimeNoChar returns the mime string without any charset encoding information, or anything else after a ;

func MimeString 

func MimeString(sup Supported) string

MimeString gives the string representation of the canonical mime type associated with given supported mime type.

func MimeSub 

func MimeSub(mime string) string

MimeSub returns the sub-level subtype category from mime type i.e., the thing after the / -- returns empty if no / also trims off any charset encoding stuff

func MimeTop 

func MimeTop(mime string) string

MimeTop returns the top-level main type category from mime type i.e., the thing before the / -- returns empty if no /

Types

type Cat 

type Cat int32 //enums:enum

filecat.Cat is a functional category for files -- a broad functional categorization that can help decide what to do with the file.

It is computed in part from the mime type, but some types require other information.

No single categorization scheme is perfect, so any given use may require examination of the full mime type etc, but this provides a useful broad-scope categorization of file types. 

const (
	// Unknown is an unknown file category
	Unknown Cat = iota

	// Folder is a folder / directory
	Folder

	// Archive is a collection of files, e.g., zip tar
	Archive

	// Backup is a backup file (# ~ etc)
	Backup

	// Code is a programming language file
	Code

	// Doc is an editable word processing file including latex, markdown, html, css, etc
	Doc

	// Sheet is a spreadsheet file (.xls etc)
	Sheet

	// Data is some kind of data format (csv, json, database, etc)
	Data

	// Text is some other kind of text file
	Text

	// Image is an image (jpeg, png, svg, etc) *including* PDF
	Image

	// Model is a 3D model
	Model

	// Audio is an audio file
	Audio

	// Video is a video file
	Video

	// Font is a font file
	Font

	// Exe is a binary executable file (scripts go in Code)
	Exe

	// Bin is some other type of binary (object files, libraries, etc)
	Bin
)
const CatN Cat = 16

CatN is the highest valid value for type Cat, plus one.

func CatFromMime 

func CatFromMime(mime string) Cat

filecat.CatFromMime returns the file category based on the mime type -- not all Cats can be inferred from file types

func CatValues 

func CatValues() []Cat

CatValues returns all possible values for the type Cat.

func (Cat) Desc 

func (i Cat) Desc() string

Desc returns the description of the Cat value.

func (Cat) Int64 

func (i Cat) Int64() int64

Int64 returns the Cat value as an int64.

func (Cat) IsValid 

func (i Cat) IsValid() bool

IsValid returns whether the value is a valid option for type Cat.

func (Cat) MarshalText 

func (i Cat) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (*Cat) SetInt64 

func (i *Cat) SetInt64(in int64)

SetInt64 sets the Cat value from an int64.

func (*Cat) SetString 

func (i *Cat) SetString(s string) error

SetString sets the Cat value from its string representation, and returns an error if the string is invalid.

func (Cat) String 

func (i Cat) String() string

String returns the string representation of this Cat value.

func (*Cat) UnmarshalText 

func (i *Cat) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (Cat) Values 

func (i Cat) Values() []enums.Enum

Values returns all possible values for the type Cat.

type FileInfo 

type FileInfo struct {

	// icon for file
	Ic icons.Icon `tableview:"no-header"`

	// name of the file, without any path
	Name string `width:"40"`

	// size of the file in bytes
	Size FileSize

	// type of file / directory -- shorter, more user-friendly version of mime type, based on category
	Kind string `width:"20" max-width:"20"`

	// full official mime type of the contents
	Mime string `tableview:"-"`

	// functional category of the file, based on mime data etc
	Cat Cat `tableview:"-"`

	// supported file type
	Sup Supported `tableview:"-"`

	// file mode bits
	Mode os.FileMode

	// time that contents (only) were last modified
	ModTime FileTime

	// version control system status, when enabled
	Vcs vci.FileStatus `tableview:"-"`

	// full path to file, including name -- for file functions
	Path string `tableview:"-"`
}

FileInfo represents the information about a given file / directory, including icon, mimetype, etc

func NewFileInfo 

func NewFileInfo(fname string) (*FileInfo, error)

func (*FileInfo) Delete 

func (fi *FileInfo) Delete() error

Delete deletes the file or if a directory the directory and all files and subdirectories

func (*FileInfo) Duplicate 

func (fi *FileInfo) Duplicate() (string, error)

Duplicate creates a copy of given file -- only works for regular files, not directories.

func (*FileInfo) FileNames 

func (fi *FileInfo) FileNames(names *[]string) (err error)

FileNames returns a slice of file names from the starting directory and its subdirectories

func (*FileInfo) FindIcon 

func (fi *FileInfo) FindIcon() (icons.Icon, bool)

FindIcon uses file info to find an appropriate icon for this file -- uses Kind string first to find a correspondingly-named icon, and then tries the extension. Returns true on success.

func (*FileInfo) InitFile 

func (fi *FileInfo) InitFile(fname string) error

InitFile initializes a FileInfo based on a filename -- directly returns filepath.Abs or os.Stat error on the given file. filename can be anything that works given current directory -- Path will contain the full filepath.Abs path, and Name will be just the filename.

func (*FileInfo) IsDir 

func (fi *FileInfo) IsDir() bool

IsDir returns true if file is a directory (folder)

func (*FileInfo) IsExec 

func (fi *FileInfo) IsExec() bool

IsExec returns true if file is an executable file

func (*FileInfo) IsHidden 

func (fi *FileInfo) IsHidden() bool

IsHidden returns true if file name starts with . or _ which are typically hidden 

func (fi *FileInfo) IsSymlink() bool

IsSymLink returns true if file is a symbolic link

func (*FileInfo) Rename 

func (fi *FileInfo) Rename(path string) (newpath string, err error)

Rename renames (moves) this file to given new path name Updates the FileInfo setting to the new name, although it might be out of scope if it moved into a new path

func (*FileInfo) RenamePath 

func (fi *FileInfo) RenamePath(path string) (newpath string, err error)

RenamePath returns the proposed path or the new full path. Does not actually do the renaming -- see Rename method.

func (*FileInfo) Stat 

func (fi *FileInfo) Stat() error

Stat runs os.Stat on file, returns any error directly but otherwise updates file info, including mime type, which then drives Kind and Icon -- this is the main function to call to update state.

type FileSize 

type FileSize datasize.ByteSize

func (*FileSize) FromInt 

func (fs *FileSize) FromInt(val int64)

FromInt satisfies the ints.Inter interface

func (FileSize) Int 

func (fs FileSize) Int() int64

Int satisfies the kit.Inter interface for sorting etc

func (FileSize) String 

func (fs FileSize) String() string

type FileTime 

type FileTime time.Time

FileTime provides a default String format for file modification times, and other useful methods -- will plug into Value with date / time editor.

func (*FileTime) FromInt 

func (ft *FileTime) FromInt(val int64)

FromInt satisfies the ints.Inter interface

func (FileTime) Int 

func (ft FileTime) Int() int64

Int satisfies the ints.Inter interface for sorting etc

func (FileTime) MarshalBinary 

func (ft FileTime) MarshalBinary() ([]byte, error)

func (FileTime) MarshalJSON 

func (ft FileTime) MarshalJSON() ([]byte, error)

func (FileTime) MarshalText 

func (ft FileTime) MarshalText() ([]byte, error)

func (FileTime) String 

func (ft FileTime) String() string

func (*FileTime) UnmarshalBinary 

func (ft *FileTime) UnmarshalBinary(data []byte) error

func (*FileTime) UnmarshalJSON 

func (ft *FileTime) UnmarshalJSON(data []byte) error

func (*FileTime) UnmarshalText 

func (ft *FileTime) UnmarshalText(data []byte) error

type MimeType 

type MimeType struct {

	// mimetype string: type/subtype
	Mime string

	// file extensions associated with this file type
	Exts []string

	// category of file
	Cat Cat

	// if supported, the name of the supported file type, else NoSupport
	Sup Supported
}

MimeType contains all the information associated with a given mime type

type Supported 

type Supported int32 //enums:enum

filecat.Supported are file types that are specifically supported by GoGi and can be processed in one way or another, plus various others that we SHOULD be able to process at some point 

const (
	// NoSupport = a non-supported file type
	NoSupport Supported = iota

	// Any is used when selecting a file type, if any type is OK (including NoSupport)
	// see also AnySupported and the Any options for each category
	Any

	// AnySupported is used when selecting a file type, if any Supported
	// file type is OK (excludes NoSupport) -- see Any and Any options for each category
	AnySupported

	// Folder is a folder / directory
	AnyFolder

	// Archive is a collection of files, e.g., zip tar
	AnyArchive
	Multipart
	Tar
	Zip
	GZip
	SevenZ
	Xz
	BZip
	Dmg
	Shar

	// Backup files
	AnyBackup
	Trash

	// Code is a programming language file
	AnyCode
	Ada
	Bash
	Csh
	C // includes C++
	CSharp
	D
	Diff
	Eiffel
	Erlang
	Forth
	Fortran
	FSharp
	Go
	Haskell
	Java
	JavaScript
	Lisp
	Lua
	Makefile
	Mathematica
	Matlab
	ObjC
	OCaml
	Pascal
	Perl
	Php
	Prolog
	Python
	R
	Ruby
	Rust
	Scala
	Tcl

	// Doc is an editable word processing file including latex, markdown, html, css, etc
	AnyDoc
	BibTeX
	TeX
	Texinfo
	Troff

	Html
	Css
	Markdown
	Rtf
	MSWord
	OpenText
	OpenPres
	MSPowerpoint

	EBook
	EPub

	// Sheet is a spreadsheet file (.xls etc)
	AnySheet
	MSExcel
	OpenSheet

	// Data is some kind of data format (csv, json, database, etc)
	AnyData
	Csv
	Json
	Xml
	Protobuf
	Ini
	Tsv
	Uri
	Color
	GoGi
	Yaml

	// Text is some other kind of text file
	AnyText
	PlainText // text/plain mimetype -- used for clipboard
	ICal
	VCal
	VCard

	// Image is an image (jpeg, png, svg, etc) *including* PDF
	AnyImage
	Pdf
	Postscript
	Gimp
	GraphVis
	Gif
	Jpeg
	Png
	Svg
	Tiff
	Pnm
	Pbm
	Pgm
	Ppm
	Xbm
	Xpm
	Bmp
	Heic
	Heif

	// Model is a 3D model
	AnyModel
	Vrml
	X3d

	// Audio is an audio file
	AnyAudio
	Aac
	Flac
	Mp3
	Ogg
	Midi
	Wav

	// Video is a video file
	AnyVideo
	Mpeg
	Mp4
	Mov
	Ogv
	Wmv
	Avi

	// Font is a font file
	AnyFont
	TrueType
	WebOpenFont

	// Exe is a binary executable file
	AnyExe

	// Bin is some other unrecognized binary type
	AnyBin
)

These are the supported file types, organized by category 

const SupportedN Supported = 125

SupportedN is the highest valid value for type Supported, plus one.

func ExtSupported 

func ExtSupported(ext string) Supported

ExtSupported returns the supported type for given file extension, or NoSupport if not found or not a supported file type

func MimeSupported 

func MimeSupported(mime string) Supported

MimeSupported returns the supported type for given mime key, or NoSupport if not found or not a supported file type

func SupportedByName 

func SupportedByName(name string) (Supported, error)

SupportedByName looks up supported file type by caps or lowercase name

func SupportedFromFile 

func SupportedFromFile(fname string) Supported

SupportedFromFile returns the supported type for given file, or NoSupport if not found or not a supported file type

func SupportedValues 

func SupportedValues() []Supported

SupportedValues returns all possible values for the type Supported.

func (Supported) Cat 

func (sup Supported) Cat() Cat

Cat returns the Cat category for given supported file type

func (Supported) Desc 

func (i Supported) Desc() string

Desc returns the description of the Supported value.

func (Supported) Int64 

func (i Supported) Int64() int64

Int64 returns the Supported value as an int64.

func (Supported) IsValid 

func (i Supported) IsValid() bool

IsValid returns whether the value is a valid option for type Supported.

func (Supported) MarshalText 

func (i Supported) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (*Supported) SetInt64 

func (i *Supported) SetInt64(in int64)

SetInt64 sets the Supported value from an int64.

func (*Supported) SetString 

func (i *Supported) SetString(s string) error

SetString sets the Supported value from its string representation, and returns an error if the string is invalid.

func (Supported) String 

func (i Supported) String() string

String returns the string representation of this Supported value.

func (*Supported) UnmarshalText 

func (i *Supported) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (Supported) Values 

func (i Supported) Values() []enums.Enum

Values returns all possible values for the type Supported.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.