path: root/protoReformat.go

// Copyright 2017-2025 WIT.COM Inc. All rights reserved.
// Use of this source code is governed by the GPL 3.0

package main

import (
	"fmt"
	"iter"
	"os"
	"strings"

	"go.wit.com/log"
)

// like 'goimport' but for .proto files

var maxVarname int
var maxVartype int
var linesIter iter.Seq[string]

func protoReformat(filename string) error {
	// read in the .proto file
	data, err := os.ReadFile(filename)
	if err != nil {
		log.Info("file read failed", filename, err)
		return err
	}

	var inMessage bool
	var newfile string
	var fmtmsg *FormatMsg
	fmtmsg = new(FormatMsg)

	linesIter = makeLineIter(data)

	var bigName int64
	var bigType int64

	// gets the max vartype and varname
	for line := range linesIter {
		if strings.HasPrefix(line, "message ") {
			inMessage = true
			continue
		}

		// find the end of the message
		if strings.HasPrefix(line, "}") {
			inMessage = false
			// formatMessage(curmsg)
			formatMessage2(fmtmsg)
			if bigName < fmtmsg.MaxVarname {
				bigName = fmtmsg.MaxVarname
			}
			if bigType < fmtmsg.MaxVartype {
				bigType = fmtmsg.MaxVartype
			}
			fmtmsg = new(FormatMsg)
			continue
		}

		// don't format or change anything when not in a "message {" section
		if !inMessage {
			continue
		}
		fmtmsg.Lines = append(fmtmsg.Lines, line)
	}

	maxVarname = int(bigName)
	maxVartype = int(bigType)

	var curmsg []string

	// gets the max vartype and varname
	for line := range linesIter {
		if strings.HasPrefix(line, "message ") {
			if inMessage {
				// message inception. search for the architect. don't forget your totem
			}
			inMessage = true
			parts := strings.Fields(line)
			if len(parts) > 3 {
				// hack to actually indent comments on the message line itself. you're welcome
				start := parts[0] + " " + parts[1] + " " + parts[2]
				end := strings.Join(parts[3:], " ")
				offset := int(bigName) + int(bigType) + 16 - len(start)
				pad := fmt.Sprintf("%d", offset)
				hmm := "%s     %" + pad + "s %s"
				line = fmt.Sprintf(hmm, start, " ", end)
			}
			newfile += fmt.Sprintln(line)
			continue
		}

		// find the end of the message
		if strings.HasPrefix(line, "}") {
			inMessage = false
			// format and write the last message to the file
			for _, newline := range formatMessage(curmsg) {
				newfile += fmt.Sprintln(newline)
			}
			newfile += fmt.Sprintln(line)
			curmsg = nil
			continue
		}

		// don't format or change anything when not in a "message {" section
		if !inMessage {
			newfile += fmt.Sprintln(line)
			continue
		}
		curmsg = append(curmsg, line)
	}

	pf, err := os.OpenFile(filename, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)
	if err != nil {
		log.Info("file open error. permissions?", filename, err)
		return err
	}
	newfile = strings.TrimSpace(newfile)
	fmt.Fprintln(pf, newfile)
	pf.Close()

	// for i, s := range slices.Backward(pf.ToSort) {
	return nil
}

func formatMessage(curmsg []string) []string {
	var newmsg []string

	// find the max length of varname and vartype
	for _, line := range curmsg {
		parts := strings.Split(line, ";")
		if len(parts) < 2 {
			// line is blank or just a comment
			continue
		}

		vartype, varname, _, _ := tokenMsgVar(line)
		if len(vartype) > maxVartype {
			maxVartype = len(vartype)
		}
		if len(varname) > maxVarname {
			maxVarname = len(varname)
		}
	}

	for _, line := range curmsg {
		line = strings.TrimSpace(line)
		if line == "" {
			newmsg = append(newmsg, line)
			continue
		}
		if strings.HasPrefix(line, "//") {
			pad := fmt.Sprintf("%d", maxVartype+maxVarname+21)
			hmm := "%" + pad + "s %s"
			line = fmt.Sprintf(hmm, " ", line) // todo: compute 50
			newmsg = append(newmsg, line)
			continue
		}
		mt := fmt.Sprintf("%d", maxVartype)
		mv := fmt.Sprintf("%d", maxVarname)

		hmm := "        %-" + mt + "s   %-" + mv + "s     = %-3s %s"

		vartype, varname, id, end := tokenMsgVar(line)
		end = strings.TrimSpace(end)
		id = id + ";"

		newline := fmt.Sprintf(hmm, vartype, varname, id, end)
		newline = strings.TrimRight(newline, " ")
		newmsg = append(newmsg, newline)
	}
	return newmsg
}

// returns vartype, varname, id, end
func tokenMsgVar(line string) (string, string, string, string) {
	parts := strings.Split(line, ";")
	front := parts[0]
	end := strings.Join(parts[1:], ";")

	var id string
	var varname string
	var vartype string

	parts = strings.Fields(front)
	parts, id = slicesPop(parts)
	parts, _ = slicesPop(parts) // this is the "=" sign
	parts, varname = slicesPop(parts)
	vartype = strings.Join(parts, " ")

	return vartype, varname, id, end
}

func slicesPop(parts []string) ([]string, string) {
	if len(parts) == 0 {
		return nil, ""
	}
	if len(parts) == 1 {
		return nil, parts[0]
	}
	x := len(parts)
	end := parts[x-1]
	return parts[0 : x-1], end
}

// 'for x := range' syntax using the awesome golang 1.24 'iter'
func makeLineIter(data []byte) iter.Seq[string] {
	items := strings.Split(string(data), "\n")
	// log.Println("Made All() Iter.Seq[] with length", len(items))
	return func(yield func(string) bool) {
		for _, v := range items {
			if !yield(v) {
				return
			}
		}
	}
}

func formatMessage2(curmsg *FormatMsg) []string {
	var newmsg []string

	// find the max length of varname and vartype
	for _, line := range curmsg.Lines {
		parts := strings.Split(line, ";")
		if len(parts) < 2 {
			// line is blank or just a comment
			continue
		}

		vartype, varname, _, _ := tokenMsgVar(line)
		if len(vartype) > int(curmsg.MaxVartype) {
			curmsg.MaxVartype = int64(len(vartype))
		}
		if len(varname) > int(curmsg.MaxVarname) {
			curmsg.MaxVarname = int64(len(varname))
		}
	}

	for _, line := range curmsg.Lines {
		line = strings.TrimSpace(line)
		if line == "" {
			newmsg = append(newmsg, line)
			continue
		}
		if strings.HasPrefix(line, "//") {
			pad := fmt.Sprintf("%d", curmsg.MaxVartype+curmsg.MaxVarname+21)
			hmm := "%" + pad + "s %s"
			line = fmt.Sprintf(hmm, " ", line) // todo: compute 50
			newmsg = append(newmsg, line)
			continue
		}
		mt := fmt.Sprintf("%d", curmsg.MaxVartype)
		mv := fmt.Sprintf("%d", curmsg.MaxVarname)

		hmm := "        %-" + mt + "s   %-" + mv + "s     = %-3s %s"

		vartype, varname, id, end := tokenMsgVar(line)
		end = strings.TrimSpace(end)
		id = id + ";"

		newline := fmt.Sprintf(hmm, vartype, varname, id, end)
		newline = strings.TrimRight(newline, " ")
		newmsg = append(newmsg, newline)
	}
	return newmsg
}