|
Multivalent API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmultivalent.VObject
multivalent.Behavior
multivalent.std.adaptor.ManualPageVolume
Collect all man pages in user's MANPATH environment variable. Big list of all pages read, alphabetized, by volume. Use standard system help mechanism, multiple media types (for possible Texinfo)
Intercepts manpage protocol (e.g., "manpage:ls(1)" or "manpage:ascii.5" or "manpage:sort") to look up in its database
Principle: Separate UI from media adaptor.
Discarded ideas:
Later, perhaps
ManualPage
Field Summary | |
---|---|
static java.lang.String |
ENV_MANPATH
|
static java.lang.String |
MSG_DATABASE
Request database to be rebuilt, to pick up changes made. |
static java.lang.String |
MSG_EXISTS
Determine whether manual page exists in database, in any section. |
static java.lang.String |
MSG_KILLCATS
Formatting on today's machines is so fast that there is no need for cached formatted "cat" pages; request to delete them. |
static java.lang.String |
MSG_SECTION_VALID
Determine whether manual page section / volume letter is valid. |
static java.lang.String |
PREF_DIR
Boolean indicating whether or not to show file system directories of man page roots. |
static java.lang.String |
PREF_RECENT
Boolean indicating whether or not to scan for and show recently added (or changed) man pages. |
static java.lang.String |
PREF_VOLNAMES
List of volume names separated by colons, parallel to PREF_RECENT . |
static java.lang.String |
PREF_VOLUMES
List of letters separated by colons corresponding to volume extensions. |
static java.lang.String |
PROTOCOL
|
Fields inherited from class multivalent.Behavior |
---|
ATTR_BEHAVIOR, name_ |
Fields inherited from class multivalent.VObject |
---|
attr_ |
Constructor Summary | |
---|---|
ManualPageVolume()
|
Method Summary | |
---|---|
void |
buildDatabase()
Scan directories of MANPATH and collect page names. |
void |
configure()
Set up MANPATH, volume letters and names. |
static void |
main(java.lang.String[] argv)
Test database reading. |
void |
restore(ESISNode n,
java.util.Map<java.lang.String,java.lang.Object> attr,
Layer layer)
Takes the place of a constructor's initialization functions; that is, it is invoked exactly once immediately after object instantiation. |
boolean |
semanticEventAfter(SemanticEvent se,
java.lang.String msg)
Intercept openDocument with manpage protocol. |
boolean |
semanticEventBefore(SemanticEvent se,
java.lang.String msg)
Round robin distribution to all behaviors. |
java.lang.String |
showPage(java.lang.String page)
Parse page spec, look up in database, report if no found or multiple matches, or openDocument on single match. |
java.lang.String |
showVolume(java.lang.String volnum)
Writes HTML page that list all pages in specified volume number, or all pages in database for "*". |
Methods inherited from class multivalent.Behavior |
---|
buildAfter, buildBefore, checkRep, clipboardAfter, clipboardBefore, createUI, destroy, eventAfter, eventBefore, formatAfter, formatBefore, getBrowser, getDocument, getInstance, getInstance, getLayer, getLogger, getName, getPreference, getRoot, isEditable, paintAfter, paintBefore, putPreference, redo, restoreChildren, save, setName, toString, undo |
Methods inherited from class multivalent.VObject |
---|
attrEntrySetIterator, attrKeysIterator, clearAttributes, getAttr, getAttr, getAttributes, getGlobal, getValue, hasAttributes, putAttr, removeAttr, setAttributes |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String MSG_EXISTS
"manualpageExists": arg= String
name-of-page
public static final java.lang.String MSG_SECTION_VALID
"manualpageValidSection": arg= String
string-to-check / Boolean
returned-answer
public static final java.lang.String MSG_DATABASE
"rebuildManPageDatabaseNewCommand2".
public static final java.lang.String MSG_KILLCATS
"manpageDeleteCats".
public static final java.lang.String PROTOCOL
public static final java.lang.String PREF_DIR
public static final java.lang.String PREF_RECENT
public static final java.lang.String ENV_MANPATH
public static final java.lang.String PREF_VOLUMES
public static final java.lang.String PREF_VOLNAMES
PREF_RECENT
.
Constructor Detail |
---|
public ManualPageVolume()
Method Detail |
---|
public boolean semanticEventBefore(SemanticEvent se, java.lang.String msg)
Behavior
semanticEventBefore
in class Behavior
public boolean semanticEventAfter(SemanticEvent se, java.lang.String msg)
semanticEventAfter
in class Behavior
public java.lang.String showVolume(java.lang.String volnum)
public java.lang.String showPage(java.lang.String page)
public void configure()
public void buildDatabase()
MANPATH
and collect page names.
public void restore(ESISNode n, java.util.Map<java.lang.String,java.lang.Object> attr, Layer layer)
Behavior
restore
in class Behavior
public static void main(java.lang.String[] argv)
|
Multivalent API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |