ctags-lang-tcl(7)

💖 ctags-lang-tcl — the tea on tagging Tcl with Universal Ctags 💖

okay bestie, so this is ctags-lang-tcl, a page from the Universal Ctags manual (section 7, the misc-notes section, we love her). It's literally just a lil collection of random notes about tagging tcl source code. no cap. let's get into it 🫶

---

✨ SYNOPSIS ✨

the three ways you might summon this energy:

ctags ... --languages=+Tcl ...
ctags ... --language-force=Tcl ...
ctags ... --map-Tcl=+.tcl ...

---

🌸 DESCRIPTION 🌸

This man page gathers random notes about tagging tcl source code. that's it, that's the description. short and iconic 💅

---

👑 TAGGING language objects of OO Extensions 👑

so here's the situation. the TclOO parser and the ITcl parser are subparsers running on top of the Tcl parser — like little sidekicks riding along. and as their names suggest (they're very self-explanatory, main character energy fr), they exist to tag the language objects of the object oriented programming extensions for the Tcl language.

here's the activation spell ✨:

• A pattern, "namespace import oo" in an input file activates the TclOO parser.
• A pattern, "namespace import itcl" in an input file activates the ITcl parser.

---

but 😭 there are cases where one of the OO extensions is being used even though neither pattern appeared in the input file. rude, honestly.

consider the following input files:

"main.tcl"

package require Itcl
namespace import itcl::*
source input.tcl

"input.tcl"

class MyClass {
        public method foo {} {
        }
}

the pattern that activates the ITcl parser is not appeared in "input.tcl" even though the class command is used. so as a result, ctags cannot extract "MyClass". tragic. the class is right there and ctags is just 👩‍🦯

---

the parameters TclOO.forceUse=true|[false] and ITcl.forceuse=true|[false] exist for handling exactly this situation. with these parameters, you can force ctags to activate one of the subparsers 💪

you can use the parameters like --param-ITcl.forceuse=true on a command-line, easy peasy:

--param-ITcl.forceuse=true

⚠️ okay important note bestie, listen up: you can enable only one of the ITcl parser or the TclOO parser. enabling both parsers by specifying the parameters can cause unexpected results. so don't be greedy, pick one. iykyk 💀

---

🦋 SEE ALSO 🦋

• ctags(1)

---

and that's the whole page, babe!! this was Universal Ctags, version 6.2.1, dropping the ctags-lang-tcl(7) manual goodness on ya. go forth and tag your tcl, you absolute icon 🌈⭐💜