MyDocument.h File Reference

---

Detailed Description

Sole document type for Crescat.

This header describes MyDocument, the document that encompasses a Crescat session document, encompassing settings, terminal state and content, and scrollback buffer. It also defines string constants labeling the saveable file types, and the states describing the progress of an ssh connnection.

Definition in file MyDocument.h.

#import <Cocoa/Cocoa.h>

Include dependency graph for MyDocument.h:

Go to the source code of this file.

Data Structures
class	MyDocument
	Terminal-and-scrollback for SSH sessions. More...
Enumerations
enum	ConnectionExpectState {   expectPassOrKey, expectPass, expectRejectOrTraffic, expectTraffic,   expectNothing }
	Connection-state description for MyDocument These constants denote the states a session goes through in the course of establishing, authenticating, running, and maintaining an ssh terminal session. More...
Variables
NSString *const	SessionFileType
	Native file type for MyDocument This is the token identifying the native save type for MyDocument, which saves settings and styled scrollback and content.
NSString *const	PlainTextFileType
	Plain-text saved-file format This token identifies the plain-text format for saving MyDocument files.
NSString *const	RichTextFileType
	Rich-text saved-file format This token identifies the rich-text format for saving MyDocument files.

---

Enumeration Type Documentation

enum ConnectionExpectState

Connection-state description for MyDocument These constants denote the states a session goes through in the course of establishing, authenticating, running, and maintaining an ssh terminal session. The state machine starts when ssh has been started in the pseudo-terminal. Enumerator: expectPassOrKey  Initial state. Ssh expected to present either a yes/no question or ask for a password or passphrase. expectPass  Ssh expected to present a password prompt. expectRejectOrTraffic  Expecting response to the password. Go to expectTraffic if success, expectPass if a retry is offered, or expectNothing otherwise. expectTraffic  The connected state. Traffic through the ssh session is the only thing coming from the PTYTask. Continues until the PTYTask notifies that the task has finished, when the state becomes expectNothing. expectNothing  The connection has terminated. No processing is done on any further output. Definition at line 42 of file MyDocument.h.

---

Variable Documentation

NSString* const PlainTextFileType

Plain-text saved-file format This token identifies the plain-text format for saving MyDocument files. Suffix is .txt, and the content is solely the unstyled Unicode bytes in the screen and scrollback. Definition at line 28 of file MyDocument.m. Referenced by MyDocument::dataRepresentationOfType:, and MyDocument::loadDataRepresentation:ofType:.

NSString* const RichTextFileType

Rich-text saved-file format This token identifies the rich-text format for saving MyDocument files. Suffix is .rtf, and the content is the screen and scrollback text, with RTF styles preserving what his preservable of colors, underlines, boldfacing, etc. Blinking gets lost. Definition at line 29 of file MyDocument.m. Referenced by MyDocument::dataRepresentationOfType:, and MyDocument::loadDataRepresentation:ofType:.

NSString* const SessionFileType

Native file type for MyDocument This is the token identifying the native save type for MyDocument, which saves settings and styled scrollback and content. When reopened, the connection can be resumed. Definition at line 27 of file MyDocument.m. Referenced by MyDocument::dataRepresentationOfType:.

---