history.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
VOID	HistoryAddEntry (PCONSRV_CONSOLE Console, PUNICODE_STRING ExeName, PUNICODE_STRING Entry)
BOOL	HistoryFindEntryByPrefix (PCONSRV_CONSOLE Console, PUNICODE_STRING ExeName, PUNICODE_STRING Prefix, PUNICODE_STRING Entry)
VOID	HistoryGetCurrentEntry (PCONSRV_CONSOLE Console, PUNICODE_STRING ExeName, PUNICODE_STRING Entry)
BOOL	HistoryRecallHistory (PCONSRV_CONSOLE Console, PUNICODE_STRING ExeName, INT Offset, PUNICODE_STRING Entry)
VOID	HistoryDeleteCurrentBuffer (PCONSRV_CONSOLE Console, PUNICODE_STRING ExeName)
VOID	HistoryDeleteBuffers (PCONSRV_CONSOLE Console)
VOID	HistoryReshapeAllBuffers (IN PCONSRV_CONSOLE Console, IN ULONG HistoryBufferSize, IN ULONG MaxNumberOfHistoryBuffers, IN BOOLEAN HistoryNoDup)

Function Documentation

HistoryAddEntry()

VOID HistoryAddEntry	(	PCONSRV_CONSOLE	Console,
		PUNICODE_STRING	ExeName,
		PUNICODE_STRING	Entry
	)

Definition at line 185 of file history.c.

{
    // UNICODE_STRING NewEntry;
    PHISTORY_BUFFER Hist = HistoryCurrentBuffer(Console, ExeName);
 
    if (!Hist) return;
 
    // NewEntry.Length = NewEntry.MaximumLength = Console->LineSize * sizeof(WCHAR);
    // NewEntry.Buffer = Console->LineBuffer;
 
    /* Don't add blank or duplicate entries */
    if (Entry->Length == 0 || Hist->MaxEntries == 0 ||
        (Hist->NumEntries > 0 &&
         RtlEqualUnicodeString(&Hist->Entries[Hist->NumEntries - 1], Entry, FALSE)))
    {
        return;
    }
 
    if (Console->HistoryNoDup)
    {
        INT i;
 
        /* Check if this line has been entered before */
        for (i = Hist->NumEntries - 1; i >= 0; i--)
        {
            if (RtlEqualUnicodeString(&Hist->Entries[i], Entry, FALSE))
            {
                UNICODE_STRING NewEntry;
 
                /* Just rotate the list to bring this entry to the end */
                NewEntry = Hist->Entries[i];
                RtlMoveMemory(&Hist->Entries[i], &Hist->Entries[i + 1],
                              (Hist->NumEntries - (i + 1)) * sizeof(UNICODE_STRING));
                Hist->Entries[Hist->NumEntries - 1] = NewEntry;
                Hist->Position = Hist->NumEntries - 1;
                return;
            }
        }
    }
 
    if (Hist->NumEntries == Hist->MaxEntries)
    {
        /* List is full, remove oldest entry */
        RtlFreeUnicodeString(&Hist->Entries[0]);
        RtlMoveMemory(&Hist->Entries[0], &Hist->Entries[1],
                      --Hist->NumEntries * sizeof(UNICODE_STRING));
    }
 
    if (NT_SUCCESS(RtlDuplicateUnicodeString(0, Entry, &Hist->Entries[Hist->NumEntries])))
        Hist->NumEntries++;
    Hist->Position = Hist->NumEntries - 1;
}

Referenced by LineInputKeyDown().

HistoryDeleteBuffers()

VOID HistoryDeleteBuffers

(

PCONSRV_CONSOLE

Console

)

Definition at line 357 of file history.c.

{
    PLIST_ENTRY CurrentEntry;
    PHISTORY_BUFFER HistoryBuffer;
 
    while (!IsListEmpty(&Console->HistoryBuffers))
    {
        CurrentEntry = RemoveHeadList(&Console->HistoryBuffers);
        HistoryBuffer = CONTAINING_RECORD(CurrentEntry, HISTORY_BUFFER, ListEntry);
        HistoryDeleteBuffer(HistoryBuffer);
    }
}

Referenced by ConSrvDeleteConsole().

HistoryDeleteCurrentBuffer()

VOID HistoryDeleteCurrentBuffer	(	PCONSRV_CONSOLE	Console,
		PUNICODE_STRING	ExeName
	)

Definition at line 350 of file history.c.

{
    HistoryDeleteBuffer(HistoryCurrentBuffer(Console, ExeName));
}

Referenced by LineInputKeyDown().

HistoryFindEntryByPrefix()

BOOL HistoryFindEntryByPrefix	(	PCONSRV_CONSOLE	Console,
		PUNICODE_STRING	ExeName,
		PUNICODE_STRING	Prefix,
		PUNICODE_STRING	Entry
	)

Definition at line 273 of file history.c.

{
    INT HistPos;
 
    /* Search for history entries starting with input. */
    PHISTORY_BUFFER Hist = HistoryCurrentBuffer(Console, ExeName);
    if (!Hist || Hist->NumEntries == 0) return FALSE;
 
    /*
     * Like Up/F5, on first time start from current (usually last) entry,
     * but on subsequent times start at previous entry.
     */
    if (Console->LineUpPressed)
        Hist->Position = (Hist->Position ? Hist->Position : Hist->NumEntries) - 1;
    Console->LineUpPressed = TRUE;
 
    // Entry.Length = Console->LinePos * sizeof(WCHAR); // == Pos * sizeof(WCHAR)
    // Entry.Buffer = Console->LineBuffer;
 
    /*
     * Keep going backwards, even wrapping around to the end,
     * until we get back to starting point.
     */
    HistPos = Hist->Position;
    do
    {
        if (RtlPrefixUnicodeString(Prefix, &Hist->Entries[HistPos], FALSE))
        {
            Hist->Position = HistPos;
            *Entry = Hist->Entries[HistPos];
            return TRUE;
        }
        if (--HistPos < 0) HistPos += Hist->NumEntries;
    } while (HistPos != Hist->Position);
 
    return FALSE;
}

Referenced by LineInputKeyDown().

HistoryGetCurrentEntry()

VOID HistoryGetCurrentEntry	(	PCONSRV_CONSOLE	Console,
		PUNICODE_STRING	ExeName,
		PUNICODE_STRING	Entry
	)

Definition at line 241 of file history.c.

{
    PHISTORY_BUFFER Hist = HistoryCurrentBuffer(Console, ExeName);
 
    if (!Hist || Hist->NumEntries == 0)
        Entry->Length = 0;
    else
        *Entry = Hist->Entries[Hist->Position];
}

Referenced by LineInputKeyDown().

HistoryRecallHistory()

BOOL HistoryRecallHistory	(	PCONSRV_CONSOLE	Console,
		PUNICODE_STRING	ExeName,
		INT	Offset,
		PUNICODE_STRING	Entry
	)

Definition at line 254 of file history.c.

{
    PHISTORY_BUFFER Hist = HistoryCurrentBuffer(Console, ExeName);
    ULONG Position = 0;
 
    if (!Hist || Hist->NumEntries == 0) return FALSE;
 
    Position = Hist->Position + Offset;
    Position = min(max(Position, 0), Hist->NumEntries - 1);
    Hist->Position = Position;
 
    *Entry = Hist->Entries[Hist->Position];
    return TRUE;
}

Referenced by LineInputRecallHistory().

HistoryReshapeAllBuffers()

VOID HistoryReshapeAllBuffers	(	IN PCONSRV_CONSOLE	Console,
		IN ULONG	HistoryBufferSize,
		IN ULONG	MaxNumberOfHistoryBuffers,
		IN BOOLEAN	HistoryNoDup
	)

Definition at line 371 of file history.c.

{
    PLIST_ENTRY Entry;
    PHISTORY_BUFFER Hist;
    NTSTATUS Status;
 
    // ASSERT(Console->NumberOfHistoryBuffers <= Console->MaxNumberOfHistoryBuffers);
    if (MaxNumberOfHistoryBuffers < Console->NumberOfHistoryBuffers)
    {
        /*
         * Trim the history buffers list and reduce it up to MaxNumberOfHistoryBuffers.
         * We loop the history buffers list backwards so as to trim the oldest
         * buffers first.
         */
        while (!IsListEmpty(&Console->HistoryBuffers) &&
               (Console->NumberOfHistoryBuffers > MaxNumberOfHistoryBuffers))
        {
            Entry = RemoveTailList(&Console->HistoryBuffers);
            Hist = CONTAINING_RECORD(Entry, HISTORY_BUFFER, ListEntry);
            HistoryDeleteBuffer(Hist);
            Console->NumberOfHistoryBuffers--;
        }
        ASSERT(Console->NumberOfHistoryBuffers == MaxNumberOfHistoryBuffers);
        ASSERT(((Console->NumberOfHistoryBuffers == 0) &&  IsListEmpty(&Console->HistoryBuffers)) ||
               ((Console->NumberOfHistoryBuffers  > 0) && !IsListEmpty(&Console->HistoryBuffers)));
    }
    Console->MaxNumberOfHistoryBuffers = MaxNumberOfHistoryBuffers;
 
    /* Resize each history buffer */
    for (Entry = Console->HistoryBuffers.Flink;
         Entry != &Console->HistoryBuffers;
         Entry = Entry->Flink)
    {
        Hist = CONTAINING_RECORD(Entry, HISTORY_BUFFER, ListEntry);
        Status = HistoryResizeBuffer(Hist, HistoryBufferSize);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("HistoryResizeBuffer(0x%p, %lu) failed, Status 0x%08lx\n",
                    Hist, HistoryBufferSize, Status);
        }
    }
    Console->HistoryBufferSize = HistoryBufferSize;
 
    /* No duplicates */
    Console->HistoryNoDup = !!HistoryNoDup;
}

Referenced by CON_API_NOCONSOLE(), and ConSrvApplyUserSettings().