keyboard.h File Reference

Defines a Keyboard and related classes for handling keyboard input. More...

#include <common/map.h>
#include <common/eventHandler.h>
#include <common/inputStream.h>
#include <common/string.h>
#include <common/vector.h>
#include <drivers/driver.h>
#include <hardwarecommunication/interrupts.h>
#include <hardwarecommunication/port.h>
#include <hardwarecommunication/apic.h>
#include <cstdint>

Go to the source code of this file.

Classes
class	MaxOS::drivers::peripherals::KeyboardState
	Holds the state of the keyboard. More...
class	MaxOS::drivers::peripherals::KeyUpEvent
	Event that is triggered when a key is released. More...
class	MaxOS::drivers::peripherals::KeyDownEvent
	Event that is triggered when a key is pressed. More...
class	MaxOS::drivers::peripherals::KeyboardEventHandler
	Handles the events that are triggered by the Keyboard Driver. More...
class	MaxOS::drivers::peripherals::KeyboardInterpreter
	Interprets the scan codes from the keyboard. More...
class	MaxOS::drivers::peripherals::KeyboardInterpreterEN_US
	Interprets the scan codes from the keyboard for the EN_US keyboard layout. More...
class	MaxOS::drivers::peripherals::KeyboardDriver
	Driver for the Keyboard Controller, manages the events and the keyboard state. More...

Enumerations
enum class	MaxOS::drivers::peripherals::ScanCodeType : int { REGULAR , EXTENDED , EXTENDED_BUFFER }
	The type of scan code being sent by the keyboard. More...
enum class	MaxOS::drivers::peripherals::KeyCode : uint16_t {   A = 'A' , a = 'a' , B = 'B' , b = 'b' ,   C = 'C' , c = 'c' , D = 'D' , d = 'd' ,   E = 'E' , e = 'e' , F = 'F' , f = 'f' ,   G = 'G' , g = 'g' , H = 'H' , h = 'h' ,   I = 'I' , i = 'i' , J = 'J' , j = 'j' ,   K = 'K' , k = 'k' , L = 'L' , l = 'l' ,   M = 'M' , m = 'm' , N = 'N' , n = 'n' ,   O = 'O' , o = 'o' , P = 'P' , p = 'p' ,   Q = 'Q' , q = 'q' , R = 'R' , r = 'r' ,   S = 'S' , s = 's' , T = 'T' , t = 't' ,   U = 'U' , u = 'u' , V = 'V' , v = 'v' ,   W = 'W' , w = 'w' , X = 'X' , x = 'x' ,   Y = 'Y' , y = 'y' , Z = 'Z' , z = 'z' ,   zero = '0' , one = '1' , two = '2' , three = '3' ,   four = '4' , five = '5' , six = '6' , seven = '7' ,   eight = '8' , nine = '9' , comma = ',' , fullStop = '.' ,   exclamationMark = '!' , questionMark = '?' , quotationMark = '\"' , semicolon = ';' ,   colon = ':' , apostrophe = '\'' , slantedApostrophe = '`' , powerSign = '^' ,   dollarSign = '$' , percentSign = '' , andSign = '&' , atSign = '@' ,   underscore = '_' , lineThing = '|' , hash = '#' , backslash = '\\' ,   forwardSlash = '/' , squigglyLine = '~' , plus = '+' , minus = '-' ,   equals = '=' , multiply = '*' , lessThan = '<' , greaterThan = '>' ,   openBracket = '(' , closeBracket = ')' , openSquareBracket = '[' , closeSquareBracket = ']' ,   openCurlyBracket = '{' , closeCurlyBracket = '}' , space = ' ' , tab = '\t' ,   enter = '\n' , backspace = '\b' , f1 = 1000 , f2 ,   f3 , f4 , f5 , f6 ,   f7 , f8 , f9 , f10 ,   f11 , f12 , escape , printScreen ,   scrollLock , pauseBreak , upArrow , downArrow ,   leftArrow , rightArrow , insert , home ,   pageUp , deleteKey , end , pageDown ,   capsLock , leftShift , leftControl , leftOS ,   leftAlt , rightAlt , functionKey , rightControl ,   rightShift , numberPadLock , numberPadForwardSlash , numberPadMultiply ,   numberPadMinus , numberPadPlus , numberPadEnter , numberPadZero ,   numberPadOne , numberPadTwo , numberPadThree , numberPadFour ,   numberPadFive , numberPadSix , numberPadSeven , numberPadEight ,   numberPadNine , numberPadFullStop , numberPadHome , numberPadPageDown ,   numberPadPageUp , numberPadEnd , numberPadInsert , numberPadUpArrow ,   numberPadDownArrow , numberPadLeftArrow , numberPadRightArrow }
	A mapping of key codes to their values. More...
enum class	MaxOS::drivers::peripherals::KeyboardEvents { KEYDOWN , KEYUP }
	The events that can be triggered by the Keyboard Driver. More...

Detailed Description

Defines a Keyboard and related classes for handling keyboard input.

Date

9th October 2022

Author

Max Tyson

Definition in file keyboard.h.

Enumeration Type Documentation

KeyboardEvents

enum class MaxOS::drivers::peripherals::KeyboardEvents

strong

The events that can be triggered by the Keyboard Driver.

Definition at line 239 of file keyboard.h.

                              {
        KEYDOWN,
        KEYUP
    };

KeyCode

enum class MaxOS::drivers::peripherals::KeyCode : uint16_t

strong

A mapping of key codes to their values.

Enumerator
f1	OTHER CODES THAT ARE NOT CHARACTERS ///.

Definition at line 40 of file keyboard.h.

                       : uint16_t {
 
        // Alphabet
        A = 'A', a = 'a',
        B = 'B', b = 'b',
        C = 'C', c = 'c',
        D = 'D', d = 'd',
        E = 'E', e = 'e',
        F = 'F', f = 'f',
        G = 'G', g = 'g',
        H = 'H', h = 'h',
        I = 'I', i = 'i',
        J = 'J', j = 'j',
        K = 'K', k = 'k',
        L = 'L', l = 'l',
        M = 'M', m = 'm',
        N = 'N', n = 'n',
        O = 'O', o = 'o',
        P = 'P', p = 'p',
        Q = 'Q', q = 'q',
        R = 'R', r = 'r',
        S = 'S', s = 's',
        T = 'T', t = 't',
        U = 'U', u = 'u',
        V = 'V', v = 'v',
        W = 'W', w = 'w',
        X = 'X', x = 'x',
        Y = 'Y', y = 'y',
        Z = 'Z', z = 'z',
 
        // Numbers
        zero = '0',
        one = '1',
        two = '2',
        three = '3',
        four = '4',
        five = '5',
        six = '6',
        seven = '7',
        eight = '8',
        nine = '9',
 
        // Symbols
        comma = ',',
        fullStop = '.',
        exclamationMark = '!',
        questionMark = '?',
        quotationMark = '\"',
        semicolon = ';',
        colon = ':',
        apostrophe = '\'',
        slantedApostrophe = '`',
 
        // Signs
        powerSign = '^',
        dollarSign = '$',
        percentSign = '%',
        andSign = '&',
        atSign = '@',
 
        // Special Characters
        underscore = '_',
        lineThing = '|',
        hash = '#',
        backslash = '\\',
        forwardSlash = '/',
        squigglyLine = '~',
 
        // Math Symbols
        plus = '+',
        minus = '-',
        equals = '=',
        multiply = '*',
        lessThan = '<',
        greaterThan = '>',
 
        // Brackets
        openBracket = '(',
        closeBracket = ')',
        openSquareBracket = '[',
        closeSquareBracket = ']',
        openCurlyBracket = '{',
        closeCurlyBracket = '}',
 
        // Writing
        space = ' ',
        tab = '\t',
        enter = '\n',
        backspace = '\b',
 
 
        // Functions
        f1 = 1000,      //force it to start at 1000 so it doesn't conflict with ascii
        f2,
        f3,
        f4,
        f5,
        f6,
        f7,
        f8,
        f9,
        f10,
        f11,
        f12,
 
        // Top Row
        escape,
        printScreen,
        scrollLock,
        pauseBreak,
 
        // Arrow s
        upArrow,
        downArrow,
        leftArrow,
        rightArrow,
 
        // Keys Above Arrows
        insert,
        home,
        pageUp,
        deleteKey,
        end,
        pageDown,
 
        // Left Side
        capsLock,
        leftShift,
        leftControl,
        leftOS,                 //weird ass Windows key or command on Mac
        leftAlt,
 
        // Right Side
        rightAlt,
        functionKey,
        rightControl,
        rightShift,
 
        // Number Pad
        numberPadLock,
        numberPadForwardSlash,
        numberPadMultiply,
        numberPadMinus,
        numberPadPlus,
        numberPadEnter,
        numberPadZero,
        numberPadOne,
        numberPadTwo,
        numberPadThree,
        numberPadFour,
        numberPadFive,
        numberPadSix,
        numberPadSeven,
        numberPadEight,
        numberPadNine,
        numberPadFullStop,
 
        // Number Pad (Non Number Lock)
        numberPadHome,
        numberPadPageDown,
        numberPadPageUp,
        numberPadEnd,
        numberPadInsert,
        numberPadUpArrow,
        numberPadDownArrow,
        numberPadLeftArrow,
        numberPadRightArrow,
    };

ScanCodeType

enum class MaxOS::drivers::peripherals::ScanCodeType : int

strong

The type of scan code being sent by the keyboard.

Definition at line 30 of file keyboard.h.

                            : int {
        REGULAR,
        EXTENDED,
        EXTENDED_BUFFER
    };