#include <TextIO.h>
Inheritance diagram for TextIO:
Collaboration diagram for TextIO:
Classes | |
| struct | VgaCell |
Public Types | |
| enum | InputMode { Standard , Raw } |
| Public Types inherited from File | |
| enum | AttributeMask : uint32_t { AccessTime = 1U << 0 , ModifyTime = 1U << 1 , ChangeTime = 1U << 2 , Owner = 1U << 3 , Group = 1U << 4 , Permissions = 1U << 5 } |
Public Member Functions | |
| TextIO (String str, size_t inode, Filesystem *pParentFS, File *pParent) | |
| bool | initialise (bool bClear=true) |
| void | writeStr (const char *s, size_t len) |
| virtual uint64_t | readBytewise (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true) |
| virtual uint64_t | writeBytewise (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true) |
| virtual int | select (bool bWriting=false, int timeout=0) |
| virtual bool | isSeekable () const |
| virtual void | flipThread () |
| void | handleInput (InputManager::InputNotification &in) |
| void | markPrimary () |
| void | unmarkPrimary () |
| bool | isPrimary () const |
| void | setMode (InputMode mode) |
| InputMode | getMode () const |
| Public Member Functions inherited from File | |
| File () | |
| File (const String &name, Time::Timestamp accessedTime, Time::Timestamp modifiedTime, Time::Timestamp creationTime, uintptr_t inode, class Filesystem *pFs, size_t size, File *pParent) | |
| virtual | ~File () |
| virtual uint64_t | read (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true) final |
| size_t | readCached (uint64_t location, size_t size, uintptr_t buffer, bool(*prepare)(uintptr_t, size_t)=nullptr) |
| virtual uint64_t | write (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true) final |
| uint64_t | append (uint64_t size, uintptr_t buffer, uint64_t &location, bool bCanBlock=true) |
| WriteGuard | lockWrites () |
| virtual physical_uintptr_t | getPhysicalPage (size_t offset) |
| virtual bool | isDirectPhysicalMapping () const |
| size_t | physicalMappingFlags () const |
| virtual void | returnPhysicalPage (size_t offset) |
| virtual bool | tryBeginMappingRelease () |
| void | endMappingRelease () |
| bool | syncAndReturnPhysicalPage (size_t offset, bool async) |
| virtual bool | sync () |
| bool | syncRange (size_t offset, size_t length) |
| virtual bool | sync (size_t offset, bool async) |
| virtual bool | syncPages (const uint64_t *offsets, size_t count) |
| Time::Timestamp | getCreationTime () |
| void | setCreationTime (Time::Timestamp t) |
| Time::Timestamp | getAccessedTime () |
| void | setAccessedTime (Time::Timestamp t) |
| Time::Timestamp | getModifiedTime () |
| void | setModifiedTime (Time::Timestamp t) |
| void | setTimes (Time::Timestamp accessed, Time::Timestamp modified, bool changeAccessed, bool changeModified) |
| virtual Attributes | getAttributes () const |
| virtual XattrStatus | getExtendedAttribute (const StringView &name, void *buffer, size_t capacity, size_t &required) |
| virtual XattrStatus | listExtendedAttributes (void *buffer, size_t capacity, size_t &required) |
| virtual XattrStatus | setExtendedAttribute (const StringView &name, const void *value, size_t length, unsigned flags) |
| virtual XattrStatus | removeExtendedAttribute (const StringView &name) |
| virtual bool | prepareSharedMapping (size_t offset, size_t length) |
| String | getName () const |
| void | getName (String &s) const |
| virtual void | getFullPath (String &result, bool bWithMount=true) |
| virtual String | getFullPath (bool bWithMount=true) |
| virtual void | truncate () |
| bool | resize (size_t size) |
| virtual size_t | getSize () |
| void | setSize (size_t sz) |
| virtual bool | isSymlink () |
| virtual bool | isDirectory () |
| virtual bool | isBlockDevice () const |
| virtual uint64_t | deviceNumber () const |
| virtual bool | isPipe () const |
| virtual bool | isFifo () const |
| virtual bool | isSocket () const |
| bool | supportsRegularFileOperations () |
| virtual bool | isCharacterDevice () const |
| virtual bool | isConsole () const |
| virtual uint64_t | maximumFileSize () const |
| virtual bool | allowMapping (bool shared, bool writeRequested, bool &mayWrite) |
| bool | acquireMappingUse (bool executable, bool sharedWrite) |
| void | releaseMappingUse (bool executable, bool sharedWrite) |
| uintptr_t | getInode () const |
| virtual void | setInode (uintptr_t inode) |
| virtual uintptr_t | futexIdentity () |
| Filesystem * | getFilesystem () const |
| void | setFilesystem (Filesystem *pFs) |
| virtual void | fileAttributeChanged () |
| void | publishEvent (FileEventMask mask, const StringView &name=StringView(), bool targetIsDirectory=false) |
| virtual FileHandleStatus | subscribeInodeEvents (FileEventMask mask, const SharedPointer< FileEventObserver > &observer, FileEventSubscription &subscription) |
| virtual void | finishInodeRetirement () |
| virtual void | increaseRefCount (bool bIsWriter) |
| virtual void | decreaseRefCount (bool bIsWriter) |
| virtual bool | retainVfsReference () |
| virtual void | releaseVfsReference () |
| virtual bool | isStableVfsRoot () const |
| void | setPermissions (uint32_t perms) |
| uint32_t | getPermissions () const |
| bool | setOwnership (size_t uid, size_t gid, bool changeUid, bool changeGid) |
| void | setUid (size_t uid) |
| size_t | getUid () const |
| void | setGid (size_t gid) |
| size_t | getGid () const |
| File * | getParent () const |
| void | getNamespace (ParentLease &parent, String &name) const |
| virtual ReadyMask | queryReady (bool reading, bool writing) |
| virtual bool | supportsReadinessNotifications () const |
| void | monitor (Thread *pThread, Event *pEvent) |
| void | cullMonitorTargets (Thread *pThread) |
| void | cullMonitorTargets (Event *pEvent) |
| virtual bool | supports (const size_t command) const |
| virtual int | command (const size_t command, void *buffer) |
| virtual size_t | getBlockSize () const |
| void | markPageExternallyWritable (size_t offset) |
| size_t | populateRange (size_t offset, size_t length) |
| void | enableDirect () |
| void | disableDirect () |
| virtual void | preallocate (size_t expectedSize, bool zero=true) |
| bool | allocateRange (size_t offset, size_t length, bool keepSize=false) |
| virtual File * | open () |
| virtual File * | openForDescriptor (RetainedFile &owner) |
| Public Member Functions inherited from ReadinessSource | |
| MUST_USE_RESULT bool | subscribeReadiness (ReadyMask interest, const SharedPointer< ReadinessObserver > &observer, ReadinessSubscription &subscription) |
| virtual ReadinessGenerations | readinessGenerations () |
| Public Member Functions inherited from FileEventSource | |
| MUST_USE_RESULT bool | subscribeFileEvents (FileEventMask interest, const SharedPointer< FileEventObserver > &observer, FileEventSubscription &subscription) |
Static Public Member Functions | |
| static void | inputCallback (InputManager::InputNotification &in) |
Private Types | |
| enum | VgaColour { Black = 0 , Blue = 1 , Green = 2 , Cyan = 3 , Red = 4 , Magenta = 5 , Orange = 6 , LightGrey = 7 , DarkGrey = 8 , LightBlue = 9 , LightGreen = 10 , LightCyan = 11 , LightRed = 12 , LightMagenta = 13 , Yellow = 14 , White = 15 } |
| enum | TerminalModes { LineFeedNewLine = 0x1 , CursorKey = 0x2 , AnsiVt52 = 0x4 , Column = 0x8 , Scrolling = 0x10 , Screen = 0x20 , Origin = 0x40 , AutoWrap = 0x80 , AutoRepeat = 0x100 , Interlace = 0x200 , Inverse = 0x100000 , Bright = 0x200000 , Blink = 0x400000 , CharacterSetG0 = 0x1000000 , CharacterSetG1 = 0x2000000 } |
Private Member Functions | |
| VgaColour | adjustColour (int colour, bool up) |
| virtual bool | isBytewise () const |
| void | setColour (VgaColour *which, size_t param, bool bBright=false) |
| void | doBackspace () |
| void | doLinefeed () |
| void | doCarriageReturn () |
| void | doHorizontalTab () |
| void | checkScroll () |
| void | checkWrap () |
| void | eraseSOS () |
| void | eraseEOS () |
| void | eraseEOL () |
| void | eraseSOL () |
| void | eraseLine () |
| void | eraseScreen (uint8_t character) |
| void | goHome (ssize_t xmove=0, ssize_t ymove=0) |
| void | clearBackbuffer () |
| void | flip (bool timer=false, bool hideState=false) |
| void | initialiseVterm () |
| void | destroyVterm () |
| void | syncVtermRect (VTermRect rect) |
| void | syncVtermCell (VTermPos pos) |
| void | markVtermRect (VTermRect rect) |
| void | markVtermCell (VTermPos pos) |
| void | storeVtermScrollback (const VTermScreenCell *cells, int cols) |
| int | popVtermScrollback (VTermScreenCell *cells, int cols) |
| VgaColour | vtermColour (VTermColor colour, bool foreground) const |
| uint8_t | translate (uint32_t codepoint) |
| void | copyVtermCell (const VTermScreenCell &source, VgaCell &destination) |
Static Private Member Functions | |
| static void | vtermOutput (const char *bytes, size_t length, void *user) |
| static int | vtermDamage (VTermRect rect, void *user) |
| static int | vtermMoveRect (VTermRect dest, VTermRect src, void *user) |
| static int | vtermMoveCursor (VTermPos pos, VTermPos oldPos, int visible, void *user) |
| static int | vtermSetTermProp (VTermProp prop, VTermValue *value, void *user) |
| static int | vtermBell (void *user) |
| static int | vtermResize (int rows, int cols, void *user) |
| static int | vtermScrollbackPush (int cols, const VTermScreenCell *cells, void *user) |
| static int | vtermScrollbackPop (int cols, VTermScreenCell *cells, void *user) |
| static int | vtermScrollbackClear (void *user) |
Static Private Attributes | |
| static const int | COLOUR_BRIGHT_ADDEND = 8 |
| static const ssize_t | BACKBUFFER_COLS_WIDE = 132 |
| static const ssize_t | BACKBUFFER_COLS_NORMAL = 80 |
| static const ssize_t | BACKBUFFER_ROWS = 25 |
| static const ssize_t | BACKBUFFER_STRIDE = BACKBUFFER_COLS_WIDE |
| static const size_t | VTERM_SCROLLBACK_LINES = 64 |
Additional Inherited Members | |
| Static Public Attributes inherited from File | |
| static constexpr size_t | MaxReadPages = 32 |
| Protected Member Functions inherited from File | |
| bool | tryAcquireFilesystemOperation (OperationBarrier::Lease &operation) const |
| virtual void | updateAttributes (const Attributes &attributes, uint32_t mask) |
| virtual bool | changeOwnership (size_t uid, size_t gid, bool changeUid, bool changeGid) |
| virtual bool | allowPhysicalPage () const |
| virtual bool | prepareWrite (uint64_t location, uint64_t size) |
| virtual bool | allowResize (size_t oldSize, size_t newSize) |
| virtual bool | prepareShrink (const ShrinkContext &context, UniquePointer< PreparedShrink > &prepared) |
| virtual bool | resizeFile (size_t size) |
| virtual bool | allocateFileRange (size_t offset, size_t length) |
| virtual Mutex & | writeSerializationLock () |
| virtual Mutex & | dataMutationLock () |
| virtual size_t & | physicalPageLoans () |
| bool | clearDataCache () |
| virtual uintptr_t | readBlock (uint64_t location) |
| virtual bool | readPage (uint64_t location, uintptr_t destination) |
| virtual bool | readPages (ReadPage *pages, size_t count) |
| virtual void | writeBlock (uint64_t location, uintptr_t addr) |
| virtual void | writeBlocks (uint64_t location, uintptr_t addr, size_t length) |
| virtual void | extend (size_t newSize) |
| virtual void | extend (size_t newSize, uint64_t location, uint64_t size) |
| virtual void | publishInodeEvent (const FileEvent &event) |
| void | dataChanged () |
| void | getFilesystemLabel (HugeStaticString &s) |
| void | enableFillCacheWriteback () |
| void | shutdownFillCacheWriteback () |
| bool | syncFillCache (size_t offset, bool async, bool &present) |
| virtual bool | useFillCache () const |
| virtual MUST_USE_RESULT bool | pinBlock (uint64_t location) |
| virtual MUST_USE_RESULT uintptr_t | acquireCachedBlock (uint64_t location, bool retryChanged) |
| virtual void | unpinBlock (uint64_t location) |
| void | evict (uint64_t location) |
| void | setPermissionsOnly (uint32_t perms) |
| void | setUidOnly (size_t uid) |
| void | setGidOnly (size_t gid) |
| void | retainDetachedParent () |
| void | moveNamespace (const String &name, File *parent) |
| bool | snapshotNamespace (ParentLease &parent, String &name, FileEventMask interest) const |
| virtual CacheState & | cacheState () |
| void | setPhysicalMappingFlags (size_t flags) |
| Protected Member Functions inherited from ReadinessSource | |
| void | notifyReadiness (ReadyMask mask) |
| void | closeReadiness (ReadyMask mask=ReadyInvalid|ReadyHangup) |
| Protected Member Functions inherited from FileEventSource | |
| bool | hasFileEventObservers (FileEventMask mask) const |
| void | notifyFileEvent (const FileEvent &event) |
| void | notifyFinalFileEvent (const FileEvent &event) |
| void | beginFinalFileEvent (const FileEvent &event) |
| void | drainFileEvents () |
| void | closeFileEvents () |
| Static Protected Member Functions inherited from File | |
| static bool | writeCallback (CacheConstants::CallbackCause cause, uintptr_t loc, uintptr_t page, void *meta) |
| static bool | fillCacheCallback (CacheConstants::CallbackCause cause, uintptr_t loc, uintptr_t page, void *meta) |
| Static Protected Member Functions inherited from FileEventSource | |
| static bool | anyFileEventObservers () |
| Protected Attributes inherited from File | |
| String | m_Name |
| Time::Timestamp | m_AccessedTime |
| Time::Timestamp | m_ModifiedTime |
| Time::Timestamp | m_CreationTime |
| uintptr_t | m_Inode |
| uintptr_t | m_FutexIdentity = 0 |
| class Filesystem * | m_pFilesystem |
| size_t | m_Size |
| File * | m_pParent |
| Mutex | m_MetadataLock |
| File * | m_pDetachedParent |
| bool | m_bDetachedParentHandled |
| size_t | m_nWriters |
| size_t | m_nReaders |
| size_t | m_Uid |
| size_t | m_Gid |
| uint32_t | m_Permissions |
| CacheState | m_CacheState |
| bool | m_bDirect |
| Mutex | m_WriteLock |
| Mutex | m_DataMutationLock |
| size_t | m_PhysicalPageLoans = 0 |
| size_t | m_PhysicalMappingFlags = 0 |
| Mutex | m_Lock |
| List< MonitorTarget * > | m_MonitorTargets |
Detailed Description
Provides terminal emulation to the Vga class, if one exists. The parser is shared with the userspace terminal widget through libvterm.
Member Enumeration Documentation
◆ InputMode
◆ TerminalModes
|
private |
◆ VgaColour
Constructor & Destructor Documentation
◆ TextIO()
| TextIO::TextIO | ( | String | str, |
| size_t | inode, | ||
| Filesystem * | pParentFS, | ||
| File * | pParent | ||
| ) |
◆ ~TextIO()
Member Function Documentation
◆ adjustColour()
|
inlineprivate |
◆ checkScroll()
◆ checkWrap()
◆ clearBackbuffer()
|
private |
Clear backbuffer.
Definition at line 1733 of file TextIO.cc.
Referenced by initialise().
Here is the caller graph for this function:
◆ copyVtermCell()
|
private |
◆ destroyVterm()
◆ doBackspace()
◆ doCarriageReturn()
◆ doHorizontalTab()
◆ doLinefeed()
◆ eraseEOL()
◆ eraseEOS()
◆ eraseLine()
◆ eraseScreen()
◆ eraseSOL()
◆ eraseSOS()
◆ flip()
|
private |
Present backbuffer to the VGA instance.
Definition at line 1737 of file TextIO.cc.
References Bright, Vga::getNumCols(), Vga::getNumRows(), TextIO::VgaCell::hidden, Inverse, isPrimary(), m_bActive, and m_Lock.
Referenced by markPrimary(), and writeStr().
Here is the caller graph for this function:
◆ flipThread()
◆ getMode()
| TextIO::InputMode TextIO::getMode | ( | ) | const |
◆ goHome()
|
private |
◆ handleInput()
| void TextIO::handleInput | ( | InputManager::InputNotification & | in | ) |
◆ initialise()
| bool TextIO::initialise | ( | bool | bClear = true | ) |
Initialise and prepare for rendering. Clears the screen as a side-effect, unless false is passed in for bClear.
- Returns
- True if we can now write, false otherwise.
Definition at line 139 of file TextIO.cc.
References clearBackbuffer(), Vga::getNumCols(), Vga::getNumRows(), Machine::getVga(), Scheduler::instance(), isPrimary(), OwnedThread::join(), m_bActive, m_FlipWake, m_G0, m_Lock, m_NextInterval, Semaphore::release(), Vga::setLargestTextMode(), and Semaphore::tryAcquire().
Referenced by VirtualTerminalManager::openInactive(), and writeStr().
Here is the caller graph for this function:
◆ initialiseVterm()
◆ inputCallback()
|
static |
◆ isBytewise()
|
inlineprivatevirtual |
◆ isPrimary()
| bool TextIO::isPrimary | ( | ) | const |
Determine whether this console is primary or not.
Definition at line 2259 of file TextIO.cc.
References m_bOwnsConsole.
Referenced by flip(), initialise(), and writeStr().
Here is the caller graph for this function:
◆ isSeekable()
|
inlinevirtual |
◆ markPrimary()
| void TextIO::markPrimary | ( | ) |
Mark this console as the "primary", which means it will receive keyboard input and actively flip to the screen.
Definition at line 2240 of file TextIO.cc.
References flip(), m_bOwnsConsole, m_Lock, and Vga::moveCursor().
◆ markVtermCell()
◆ markVtermRect()
◆ popVtermScrollback()
|
private |
◆ readBytewise()
|
virtual |
Reimplemented from File.
Definition at line 1819 of file TextIO.cc.
References m_OutBuffer, and Buffer< T, allowShortOperation >::read().
◆ select()
|
virtual |
Similar to POSIX's select() function
- Returns
- 1 if ready for reading/writing, 0 otherwise
- Note
- Default implementation says always ready to read/write so be sure to override if that's not right
Reimplemented from File.
Definition at line 1828 of file TextIO.cc.
References Buffer< T, allowShortOperation >::canRead(), Buffer< T, allowShortOperation >::canWrite(), and m_OutBuffer.
◆ setColour()
|
private |
◆ setMode()
| void TextIO::setMode | ( | InputMode | mode | ) |
◆ storeVtermScrollback()
|
private |
◆ syncVtermCell()
◆ syncVtermRect()
◆ translate()
|
private |
Translate given UTF32 codepoint to an ASCII character for display.
Definition at line 1855 of file TextIO.cc.
Referenced by writeStr().
Here is the caller graph for this function:
◆ unmarkPrimary()
| void TextIO::unmarkPrimary | ( | ) |
Unmark this console as the primary, ceasing its screen updates and ceasing its reception of keyboard input.
Definition at line 2254 of file TextIO.cc.
References m_bOwnsConsole, and m_Lock.
◆ vtermBell()
◆ vtermColour()
|
private |
◆ vtermDamage()
|
staticprivate |
◆ vtermMoveCursor()
|
staticprivate |
◆ vtermMoveRect()
|
staticprivate |
◆ vtermOutput()
|
staticprivate |
◆ vtermResize()
|
staticprivate |
◆ vtermScrollbackClear()
|
staticprivate |
◆ vtermScrollbackPop()
|
staticprivate |
◆ vtermScrollbackPush()
|
staticprivate |
◆ vtermSetTermProp()
|
staticprivate |
◆ writeBytewise()
|
virtual |
Writes bytes to the file, if isBytewise() == true.
Reimplemented from File.
Definition at line 1823 of file TextIO.cc.
References writeStr().
◆ writeStr()
| void TextIO::writeStr | ( | const char * | s, |
| size_t | len | ||
| ) |
Write bytes to the screen, handling terminal control sequences embedded in the string along the way.
- Parameters
-
str The string to write.
- Todo:
- Should we handle this?
- Todo:
- hook in to Keyboard::setLedState!
- Todo:
- Sanity check.
- Todo:
- Error out if is Utf8
- Todo:
- implement me!
- Todo:
- implement me!
Definition at line 492 of file TextIO.cc.
References Bright, Buffer< T, allowShortOperation >::canRead(), File::dataChanged(), Dec, flip(), Hex, initialise(), Inverse, isPrimary(), m_bActive, m_bUtf8, m_G0, m_Lock, m_nCharacter, m_nUtf8Handled, m_OutBuffer, Vga::moveCursor(), translate(), and Buffer< T, allowShortOperation >::write().
Referenced by VirtualTerminalManager::openInactive(), and writeBytewise().
Here is the caller graph for this function:
Member Data Documentation
◆ BACKBUFFER_COLS_NORMAL
|
staticprivate |
◆ BACKBUFFER_COLS_WIDE
|
staticprivate |
◆ BACKBUFFER_ROWS
◆ BACKBUFFER_STRIDE
|
staticprivate |
◆ COLOUR_BRIGHT_ADDEND
◆ m_Back
◆ m_Backbuffer
|
private |
◆ m_bActive
|
private |
Are we currently active? We only become active once data is first written.
Definition at line 314 of file TextIO.h.
Referenced by flip(), initialise(), and writeStr().
◆ m_bBracket
◆ m_bControlSeq
◆ m_bInitialised
◆ m_bOwnsConsole
|
private |
Does this terminal own the output to the Vga instance?
Definition at line 332 of file TextIO.h.
Referenced by isPrimary(), markPrimary(), and unmarkPrimary().
◆ m_bParams
◆ m_bParenthesis
◆ m_bQuestionMark
◆ m_bUtf8
|
private |
Are we dealing with a UTF-8 codepoint currently?
Definition at line 302 of file TextIO.h.
Referenced by writeStr().
◆ m_CurrentModes
◆ m_CurrentParam
◆ m_CursorX
◆ m_CursorY
◆ m_FlipThread
|
private |
◆ m_FlipWake
|
private |
Running flip thread for things like the cursor blinking.
Definition at line 326 of file TextIO.h.
Referenced by initialise().
◆ m_Fore
◆ m_G0
|
private |
Designated character sets - simply store the character which is used to designate a character set (eg, '1', 'A').
Definition at line 296 of file TextIO.h.
Referenced by initialise(), and writeStr().
◆ m_G1
◆ m_InputMode
◆ m_LeftMargin
◆ m_Lock
|
private |
Locks writing (used for timers in particular). Avoids the case where a timer flips an in-progress operation, causing incorrect rendering.
Definition at line 321 of file TextIO.h.
Referenced by flip(), initialise(), markPrimary(), unmarkPrimary(), and writeStr().
◆ m_nCharacter
|
private |
◆ m_NextInterval
|
private |
Next interval to wait for (milliseconds).
Definition at line 299 of file TextIO.h.
Referenced by initialise().
◆ m_nUtf8Handled
|
private |
Number of Utf8 bits handled so far in this sequence.
Definition at line 308 of file TextIO.h.
Referenced by writeStr().
◆ m_OutBuffer
|
private |
Output buffer - data that we as the emulator want to write back to the application (eg, cursor position reports)
Definition at line 290 of file TextIO.h.
Referenced by readBytewise(), select(), and writeStr().
◆ m_Params
◆ m_pBackbuffer
◆ m_pFramebuffer
◆ m_pVga
◆ m_pVterm
◆ m_pVtermScreen
◆ m_pVtermState
◆ m_RightMargin
◆ m_SavedCursorX
◆ m_SavedCursorY
◆ m_ScrollEnd
◆ m_ScrollStart
◆ m_TabStops
◆ m_VtermDirty
|
private |
◆ m_VtermScrollback
|
private |
◆ m_VtermScrollbackLines
◆ VTERM_SCROLLBACK_LINES
|
staticprivate |
The documentation for this class was generated from the following files:
