Added SGR fields to the RGB struct for bold and italic;

allow RGB values to be -1 (default color);
allow underscore in color names

.gitignore

@@ -1,2 +1,3 @@
 ccat
+*.zip
 

LICENSE.md

@@ -0,0 +1,8 @@
+Copyright 2025 Aadhavan Srinivasan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -12,11 +12,20 @@ ccat is a file printing tool (like 'cat') which uses Regular Expressions to enab
 - Highly extensible - to add a config file for an specific file type, name the file `<extension>.conf`.
 - Support for printing line numbers with the `-n` flag.
 - Statically linked Go binary - no runtime dependencies, config files are distributed along with the binary.
-- Cross-platform
+- Linux and MacOS supported.
 
 ---
 
 ### Installing
+
+Download the appropriate zip-file from the 'Releases' section. Place the executable in your PATH.
+
+NOTE: The releases are not available on the GitHub repo (which is a mirror of https://gitea.twomorecents.org/Rockingcool/ccat). Obtain the [releases](https://gitea.twomorecents.org/Rockingcool/ccat/releases) from there instead.
+
+---
+
+### Building from source
+
 If you have the `go` command installed, run `make` after cloning the repository.
 
 ---
@@ -27,12 +36,11 @@ The following languages have config files included by default:
 
 - C
 - Go
--
 
 ---
 
 ### Getting Started
-The config files are embedded within the binary. They will automatically be installed to the correct location (`%APPDATA/ccat` on Windows, `~/.config/ccat` on UNIX) when the program is first run.
+The config files are embedded within the binary. They will automatically be installed to the correct location (`~/.config/ccat` on UNIX) when the program is first run.
 
 As written above, if provided a file with extension `.example`, the program will look for the config file named `example.conf`. If such a file doesn't exist, the file is printed out without any highlighting.
 
@@ -61,5 +69,5 @@ Note that the color name must be capitalized (and shouldn't contain spaces). The
 ---
 
 ### TODO:
+- Windows support.
 - Allow users to provide a config file in the command-line, overriding the extension-based config file.
-- Provide releases.

color.go

@@ -18,12 +18,17 @@ type color struct {
 	colorObj *colorData.Color
 }
 
-// A RGB represents a Red, Blue, Green trio of values. Each value is represented as
-// an int.
+// A RGB represents a Red, Blue, Green trio of values, along with SGR parameters.
+// Each value is represented as an int. For info on SGR parameters, see:
+// https://en.wikipedia.org/wiki/ANSI_escape_code#Select_Graphic_Rendition_parameters
+// If 'red', 'green' and 'blue' are all -1, then the default terminal color is used.
+// If some (but not all) of them are -1, an error is thrown.
 type RGB struct {
+	sgr1  int
 	red   int
 	blue  int
 	green int
+	sgr2  int
 }
 
 // The following is a list of all possible colors, stored in a map.
@@ -76,59 +81,79 @@ func newColorMust(colorString string) color {
 // characters.
 func isValidColorName(colorName string) bool {
 	for _, ch := range colorName {
-		if ch > 'Z' || ch < 'A' {
+		if (ch > 'Z' || ch < 'A') && (ch != '_') {
 			return false
 		}
 	}
 	return true
 }
 
-// stringToRGB takes a string representing an RGB trio. It constructs and RGB type and
+// stringToRGB takes a string representing an RGB five-tuple. It constructs and RGB type and
 // returns it. Any errors encountered are returned. If an error is returned, it is safe to
-// assume that the string doesn't represent an RGB trio.
+// assume that the string doesn't represent an RGB five-tuple.
 func stringToRGB(rgbString string) (*RGB, error) {
 	values := strings.Split(rgbString, " ")
 	// There must be three space-separated strings.
-	if len(values) != 3 {
+	if len(values) != 5 {
 		// TODO: Instead of ignoring these errors and returning a generic error (as I do in the
 		// callee), wrap the error returned from this function, inside the error returned by the callee.
-		return nil, fmt.Errorf("Error parsing RGB trio.")
+		return nil, fmt.Errorf("Error parsing RGB five-tuple.")
 	}
 	// If any of the strings doesn't represent an integer (or is out of bounds), return an error.
 	// WARNING: LAZY CODE INCOMING
 	var toReturn RGB
 	var err error
-	toReturn.red, err = strconv.Atoi(values[0])
+	toReturn.sgr1, err = strconv.Atoi(values[0])
+	if err != nil {
+		return nil, fmt.Errorf("Error parsing SGR1 integer: Invalid value.")
+	}
+	if toReturn.sgr1 < 0 || toReturn.sgr1 > 107 { // Maximum value for SGR values
+		return nil, fmt.Errorf("Error parsing SGR1 integer: Out-of-bounds.")
+	}
+	toReturn.red, err = strconv.Atoi(values[1])
 	if err != nil {
 		return nil, fmt.Errorf("Error parsing RED integer: Invalid value.")
 	}
-	if toReturn.red < 0 || toReturn.red > 255 {
+	if toReturn.red < -1 || toReturn.red > 255 {
 		return nil, fmt.Errorf("Error parsing RED integer: Out-of-bounds.")
 	}
-	toReturn.blue, err = strconv.Atoi(values[1])
+	toReturn.blue, err = strconv.Atoi(values[2])
 	if err != nil {
 		return nil, fmt.Errorf("Error parsing BLUE integer: Invalid value.")
 	}
-	if toReturn.blue < 0 || toReturn.blue > 255 {
+	if toReturn.blue < -1 || toReturn.blue > 255 {
 		return nil, fmt.Errorf("Error parsing BLUE integer: Out-of-bounds.")
 	}
-	toReturn.green, err = strconv.Atoi(values[2])
+	toReturn.green, err = strconv.Atoi(values[3])
 	if err != nil {
 		return nil, fmt.Errorf("Error parsing GREEN integer: Invalid value.")
 	}
-	if toReturn.green < 0 || toReturn.green > 255 {
+	if toReturn.green < -1 || toReturn.green > 255 {
 		return nil, fmt.Errorf("Error parsing GREEN integer: Out-of-bounds.")
 	}
+	toReturn.sgr2, err = strconv.Atoi(values[4])
+	if err != nil {
+		return nil, fmt.Errorf("Error parsing SGR2 integer: Invalid value.")
+	}
+	if toReturn.sgr2 < 0 || toReturn.sgr2 > 107 {
+		return nil, fmt.Errorf("Error parsing SGR2 integer: Out-of-bounds.")
+	}
+
+	if !(toReturn.red > 0 && toReturn.blue > 0 && toReturn.green > 0) &&
+		!(toReturn.red == -1 && toReturn.green == -1 && toReturn.blue == -1) {
+		return nil, fmt.Errorf("Error parsing color: All values must be positive or -1 for default terminal color.")
+	}
 	return &toReturn, nil
 }
 
 // loadColorsFromFile loads the colors defined in the given config file, and adds them to
 // the possibleColors map. This allows the user to define custom colors at run-time.
 // The colors config file has the following syntax:
-// COLOR: <RED> <GREEN> <BLUE>
+// COLOR: <SGR1> <RED> <GREEN> <BLUE> <SGR2>
 //
 // Note that the color must be capitalized (and not contain spaces), and the R, G and B
-// values must be from 0 to 255.
+// values must be from -1 to 255 (-1 refers to the default terminal color, and all three values
+// must be -1 for this to work).
 func loadColorsFromFile(filepath string) error {
 	data, err := os.ReadFile(filepath)
 	if err != nil {
@@ -151,8 +176,28 @@ func loadColorsFromFile(filepath string) error {
 		// If we haven't returned an error yet, the color must be valid.
 		// Add it to the map. colorData.New() expects values of type colorData.Attribute,
 		// so we must cast our RGB values accordingly.
-		possibleColors[item.Key.(string)] = color{item.Key.(string), colorData.New(38, 2, colorData.Attribute(rgb.red), colorData.Attribute(rgb.blue), colorData.Attribute(rgb.green))}
-
+		// First, check if one of the color values is -1. If it is, they must all be negative (based
+		// on the check in 'stringToRGB()'). If this is the case, don't put the color values.
+		if rgb.red == -1 {
+			possibleColors[item.Key.(string)] = color{
+				item.Key.(string),
+				colorData.New(
+					colorData.Attribute(rgb.sgr2),
+				),
+			}
+		} else {
+			possibleColors[item.Key.(string)] = color{
+				item.Key.(string),
+				colorData.New(
+					colorData.Attribute(rgb.sgr1),
+					2,
+					colorData.Attribute(rgb.red),
+					colorData.Attribute(rgb.blue),
+					colorData.Attribute(rgb.green),
+					colorData.Attribute(rgb.sgr2),
+				),
+			}
+		}
 	}
 
 	return nil

config.go

@@ -1,44 +1,35 @@
 package main
 
 import (
-	"ccat/stack"
 	"embed"
 	"errors"
 	"io/fs"
 	"os"
-	"os/user"
 	"path/filepath"
 	"regexp"
 	"runtime"
 	"strings"
 
+	"gitea.twomorecents.org/Rockingcool/ccat/stack"
+
 	"gopkg.in/yaml.v2"
 )
 
 //go:embed config
 var storedConfigs embed.FS // Embed the folder containing config files
 
+// runningOnWindows: At the moment this function isn't used. When Window support is added,
+// it will be used to determine if the program is being run on Windows.
 func runningOnWindows() bool {
 	return runtime.GOOS == "windows"
 }
 
 // generateDefaultConfigs is used to generate a folder of default config files
 // for common languages. These default config files are embedded into the program, and will
-// be outputted into a directory.
+// be outputted into the given directory.
 //
 // If there is an error encountered, the error is returned.
-func generateDefaultConfigs() error {
-
-	var configOutputPath string // Location of config files, depends on OS
-	if runningOnWindows() {
-		configOutputPath = "%APPDATA%\\ccat"
-	} else {
-		currentUser, err := user.Current()
-		if err != nil {
-			panic(err)
-		}
-		configOutputPath = filepath.Join("/home/" + currentUser.Username + "/.config/ccat/")
-	}
+func generateDefaultConfigs(configOutputPath string) error {
 	err := os.MkdirAll(configOutputPath, 0755)
 	if err != nil {
 		if os.IsExist(err) {
@@ -59,7 +50,7 @@ func generateDefaultConfigs() error {
 		relPath, _ := filepath.Rel("config", path)
 		dstPath := filepath.Join(configOutputPath, relPath) // Destination path
 
-		data, err := os.ReadFile(path)
+		data, err := storedConfigs.ReadFile(path)
 		if err != nil {
 			return err
 		}

config/c.conf

@@ -10,11 +10,13 @@
 # Strings in double quotes and single quotes
 '"(.*?)"': BLUE
 "'(.)'": BLUE
+# Text inside angle-brackets (used in 'include' statements)
+'\<(.*?)\>': BLUE
 # Assignments and comparisons
 # TODO: Add less than, greater than, not equal to, and struct pointer member access
 '(?:\s|\b)(=|==|!=|<=|>=|\->)(\s|\b)' : CYAN
 # Keywords
 '\b(if|else|while|do|for|return)\b': CYAN
-'^(#ifdef|#ifndef|#define|#include)\b': CYAN
+'(\n|^)(#ifdef|#ifndef|#define|#include)\b': CYAN
 # Data Types
 '\b(int|char|float|double|void|long|short|unsigned|signed|bool)\b': YELLOW

config/ccat.colors

@@ -0,0 +1,7 @@
+# The first and last fields are SGR values, used to control things
+# like bold and italic text. If you're unsure what to put, use '38'
+# for the first one and '22' for the last one, for normal text.
+# The last three values are R G B values.
+PINK: 38 244 211 244 22
+BOLD_WHITE: 38 -1 -1 -1 1
+ITALIC_WHITE: 38 -1 -1 -1 3

config/md.conf

@@ -0,0 +1,13 @@
+# Priority decreases going downward ie. If two regexes match the same piece of
+# text, the one defined earlier will take precedence over the one defined later.
+# Headings
+'##?#?#?#?#?.*': MAGENTA
+
+# Code blocks
+'```(.|\n)+?```': YELLOW
+
+# Bold text
+'\b__[^_]+?__\b': BOLD_WHITE
+
+# Italic text
+'\b_[^_]+?_\b': ITALIC_WHITE

create_release_builds.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -euo pipefail
+
+POSSIBLE_GOOS=( "linux" "darwin" )
+POSSIBLE_GOARCH=( "amd64" "arm64" )
+
+for OS in "${POSSIBLE_GOOS[@]}"; do
+	for ARCH in "${POSSIBLE_GOARCH[@]}"; do
+		FOLDER_NAME="ccat-$OS-$ARCH"
+		mkdir "${FOLDER_NAME}"
+		GOOS=$OS GOARCH=$ARCH go build -o "${FOLDER_NAME}/"
+		zip -r "${FOLDER_NAME}" "${FOLDER_NAME}"
+		rm -r "${FOLDER_NAME}"
+	done
+done
+

go.mod

@@ -1,4 +1,4 @@
-module ccat
+module gitea.twomorecents.org/Rockingcool/ccat
 
 go 1.22.5
 

main.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"math"
 	"os"
-	"os/user"
 	"path/filepath"
 )
 
@@ -78,18 +77,13 @@ func main() {
 	flag.Parse()
 
 	// Check if config exists. If it doesn't, generate the config files.
-	var configPath string // Location of config files, depends on OS
-	if runningOnWindows() {
-		configPath = "%APPDATA%\\ccat"
-	} else {
-		currentUser, err := user.Current()
+	userHomeDir, err := os.UserHomeDir() // Get current user's home directory, to construct config path
 	if err != nil {
 		panic(err)
 	}
-		configPath = filepath.Join("/home/" + currentUser.Username + "/.config/ccat/")
-	}
+	configPath := filepath.Join(userHomeDir + "/.config/ccat/")
 	if _, err := os.Stat(configPath); os.IsNotExist(err) {
-		generateDefaultConfigs()
+		generateDefaultConfigs(configPath)
 	}
 
 	// Check if user has provided a file name

todo.txt

@@ -1,5 +1,4 @@
 1. Man page
-2. README for GitHub Repo
 2. Logging
 3. Coloring functions
 4. Flag to list all available colors for your terminal - some terminals will only support the predefined colors.