General Information

Question (arch-what): What is this project good for?
Answer: The Terminal Emulator is a library used to display process output. It is designed to operate in a variety of modes, up to and including full emulation of an ANSI character terminal, similar to xterm and so on. NetBeans normally uses it to implement the Output Window, where it mostly acts as a "dumb terminal" for use in capturing output from compilers and programs run by the user; it features hyperlinks which may be used for e.g. compiler error messages. In more advanced modes it can even be used to run e.g. VI or Emacs, display margin glyphs, and so on. TerminalEmulatorAPI
Question (arch-overall): Describe the overall architecture.
WARNING: Question with id="arch-overall" has not been answered!
Question (arch-usecases): Describe the main use cases of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module?
WARNING: Question with id="arch-usecases" has not been answered!
Question (arch-time): What are the time estimates of the work?
WARNING: Question with id="arch-time" has not been answered!
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented?
WARNING: Question with id="arch-quality" has not been answered!
Question (arch-where): Where one can find sources for your module?
WARNING: Question with id="arch-where" has not been answered!

Project and platform dependencies

Question (dep-nb): What other NetBeans projects and modules does this one depend on?
Answer: None, it is a standalone library that could be used in other applications.

The default answer to this question is:


These modules are required in project.xml:

Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer: None.
Question (dep-platform): On which platforms does your module run? Does it run in the same way on each?
Answer: Should be platform-independent, as it is just a Swing component. Expects that CRNL translations have been taken care of; pluggable line discipline handlers support this. If used as a full screen-oriented terminal emulator, it would need to be attached to code that would handle PTYs, signals, etc. This would probably need to be JNI, but no such code is included as part of the library itself.
Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
Answer: 1.3.
Question (dep-jrejdk): Do you require the JDK or is the JRE enough?
Answer: JRE.

Deployment

Question (deploy-jar): Do you deploy just module JAR file(s) or other files as well?
Answer: Just a JAR.
Question (deploy-nbm): Can you deploy an NBM via the Update Center?
Answer: Yes.
Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere?
Answer: Either.
Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public?
Answer: No, there is only one package and it contains public API classes.
Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one, in addition to or instead of the normal module dependency declaration (e.g. tokens to require)?
WARNING: Question with id="deploy-dependencies" has not been answered!

Compatibility with environment

Question (compat-i18n): Is your module correctly internationalized?
Answer: The terminal emulator does not display any particular strings or icons except what is sent to it. Double-width display of oriental characters (e.g. Japanese) is supported.
Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow?
Answer:

The emulator has full compliance with the generic "dumb" terminal type. It has good but not 100% compliance with the general ANSI term specification given by ISO/IEC 6429:1992(E) / ANSI X3.64-1979. It has some functionality on top of ANSI which is modeled on the Solaris dtterm, but is not a full emulation of that termcap. Subprocesses expecting xterm or vt220 emulation should generally work as well.

The library package provides some API documentation for use by embedding applications. A subset of this API is used by the NetBeans core-output.jar module to implement the Output Window.

Question (compat-version): Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version?
Answer: N/A; no persisted settings.
Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product?
WARNING: Question with id="compat-deprecation" has not been answered!

Access to resources

Question (resources-file): Does your module use java.io.File directly?
Answer: No.
Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components?
Answer: No.
Question (resources-read): Does your module read any resources from layers? For what purpose?
Answer: No.
Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers?
Answer: No.
Question (resources-preferences): Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ?
WARNING: Question with id="resources-preferences" has not been answered!

Lookup of components

Question (lookup-lookup): Does your module use org.openide.util.Lookup or any similar technology to find any components to communicate with? Which ones?
Answer: No.
Question (lookup-register): Do you register anything into lookup for other code to find?
Answer: No.
Question (lookup-remove): Do you remove entries of other modules from lookup?
Answer: No.

Execution Environment

Question (exec-property): Is execution of your code influenced by any environment or Java system (System.getProperty) property? On a similar note, is there something interesting that you pass to java.util.logging.Logger? Or do you observe what others log?
Answer: No.
Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
Answer: No.
Question (exec-ant-tasks): Do you define or register any ant tasks that other can use?
WARNING: Question with id="exec-ant-tasks" has not been answered!
Question (exec-classloader): Does your code create its own class loader(s)?
Answer: No.
Question (exec-reflection): Does your code use Java Reflection to execute other code?
Answer: No.
Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection?
Answer: No.
Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code?
Answer: No. Note that the termulator itself has no notion of subprocesses and cannot set a TERMCAP. However, it includes simple interfaces which could be used to plug in a full Unix tty if desired. In that case the choice of reported TERMCAP is at the discretion of the code supplying the tty interface.
Question (exec-introspection): Does your module use any kind of runtime type information (instanceof, work with java.lang.Class, etc.)?
Answer: No.
Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading?
WARNING: Question with id="exec-threading" has not been answered!
Question (security-policy): Does your functionality require modifications to the standard policy file?
WARNING: Question with id="security-policy" has not been answered!
Question (security-grant): Does your code grant additional rights to some other code?
WARNING: Question with id="security-grant" has not been answered!

Format of files and protocols

Question (format-types): Which protocols and file formats (if any) does your module read or write on disk, or transmit or receive over the network? Do you generate an ant build script? Can it be edited and modified?
Answer: N/A
Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop?
Answer: N/A
Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods on java.awt.datatransfer.Transferable?
Answer: Plain Unicode text.

Performance and Scalability

Question (perf-startup): Does your module run any code on startup?
Answer: No.
Question (perf-exit): Does your module run any code on exit?
Answer: No.
Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales?
Answer: Only the size of the history buffer is relevant (to memory consumption).
Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle?
Answer: No. There is a history buffer with a fixed number of lines, so output exceeding this buffer size will continue to be displayed while earlier lines are discarded, keeping a fixed update speed for new output, subject to garbage collection etc. There will be a modest hiccup in display if more than 2³² lines of text are displayed, estimated to occur after several days running at full throttle.
Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc.
Answer: The visible screen and the scrollback buffer are kept in memory; each line is stored as a character array, so given an average of twenty characters per line, with a default history size of 10000, and including some overhead for character attribute storage etc., we can estimate a standing memory consumption after heavy usage of around one megabyte.
Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)?
Answer: No.
Question (perf-progress): Does your module execute any long-running tasks?
Answer: No.
Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas?
Answer: No.
Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic?
Answer: No.
Question (perf-spi): How the performance of the plugged in code will be enforced?
WARNING: Question with id="perf-spi" has not been answered!