iclass(1)

✨ iclass — the class browser that ate 💅

hey bestie, welcome to the manual page for iclass, and yes it lives in the General Commands Manual (section 1, the iconic one). the header up top just says iclass(1) and honestly? she earned it. 🎀

🌸 NAME

iclass — class browser. that's the whole job. she browses classes. no cap. 💖

🦋 SYNOPSIS

iclass [-r] [-v] [-c] path [path...]

👑 DESCRIPTION

okay so iclass is a simple class browser — she lets you navigate through C++ class hierarchies and view the definition of a particular class. main character energy fr fr.

you get to pick classes from three browsers:

1. the first one shows a list of all known classes
2. the second shows the parents of the selected class, if any
3. the third shows the children of the selected class, if any

you can choose a name from any of these lists and tell iclass to show the definition of that class — or you can just type the name of a class explicitly into the StringEditor labeled ``selected class.'' 💅

and the view of the class definition? it shows the source code from the header file that defines the selected class. like, the receipts. the whole receipts. 🫶

🍓 ARGUMENTS

so iclass interprets arguments that specify the header files to search for class definitions. here's the tea:

• every non-option argument on the command line should specify a pathname to a header file or a directory containing header files
• if the pathname is a filename ending in the suffix ``.h'', then iclass will scan that header file
• if the pathname is a directory, then it will scan every header file in that directory

and here's the part where you have to pay attention bestie: iclass will ignore filenames that do not end in the suffix .h'' — <red>unless</red> the -c'' option is given. in that case, iclass will search both .h'' **and** .C'' files for class definitions.

you may also use any of the standard options accepted by InterViews programs, in addition to the following options:

• -r — recursively scan subdirectories for additional header files when scanning a directory. 🌀
• -v — verbosely print the name of every header file scanned. she's narrating. let her. 🗣️
• -c — allow iclass to search .C'' files as well as .h'' for class definitions.

⚠️ bestie, use -c carefully!! because of the way that iclass searches for definitions, it is possible for it to get confused by code in a ``.C'' file and think it is a definition. 😭 nonetheless, this is a useful option if there are C++ input files that contain definitions. so like, powerful but spicy. 🔥

💜 COMMANDS

iclass provides pull-down menus for issuing commands. the ``File'' menu includes the following commands:

• Scan Files/Directories... — prompt for additional pathnames to scan. 📂
• Clear Classes — purge iclass of all classes it has scanned. clean slate, fresh start, we love a reset. 🧼
• Quit — close the window and exit. bye bestie 👋

commands in the ``Search'' menu include:

• Forward Search... — search forward in the class definition for a match with a given regular expression, wrapping from the end to the beginning of the buffer if necessary. 🔍
• Backward Search... — search backward for a match with a given regexp. ⏪
• Go to Line... — move the cursor to the beginning of the given line, scrolling the display if necessary. 📍

🖱️ MOUSE BINDINGS

the left mouse button selects text. left-clicking inside a browser, StringEditor, or class definition also focuses keyboard input to it, which lets it interpret subsequent keyboard commands as scrolling or selection operations. 👆

double left-clicking inside a browser is equivalent to selecting a class and then pressing the ``Show'' button. yes, the shortcut. slay.

the middle and right mouse buttons scroll text in different ways:

• middle-clicking lets you ``grab-scroll'' the text. during grab-scrolling, the text is scrolled to follow the mouse position, making it appear as though you are dragging the text itself. 🫳
• right-clicking engages ``rate-scrolling,'' a joy-stick-like scrolling interface in which the scrolling rate increases as you drag the mouse away from the initial click point. for example, dragging the mouse downwards after the initial click scrolls a browser downwards at an increasing rate; dragging upwards thereafter reduces the rate until scrolling stops entirely at the initial click point. dragging up beyond this point makes the browser scroll in the reverse direction. 🕹️✨

⌨️ KEYBOARD BINDINGS

for convenience, all menu commands have keyboard equivalents:

• ^V — scan a file or directory. 📂
• ^Q — quit. 🚪
• ^S — search forward. ⏩
• ^R — search backward. ⏪
• ^N — go to a line. 📍

iclass also provides keyboard commands for changing focus:

• ESC or TAB — set focus to the StringEditor showing the selected class. 🎯
• CR — show the selected class (equivalent to pressing the Show button) and set focus to the class definition. 👑

🌈 SEE ALSO

• Regexp(3I)
• StringBrowser(3I)
• StringEditor(3I)
• TextEditor(3I)

and that's the whole page bestie 🫶 this was iclass(1) from the General Commands Manual — footer's just her name again, iclass(1), because she knows who she is. 💅✨