mirror of
https://github.com/alliedmodders/hl2sdk.git
synced 2024-12-23 01:59:43 +08:00
626 lines
16 KiB
C++
626 lines
16 KiB
C++
//========= Copyright © 1996-2005, Valve Corporation, All rights reserved. ============//
|
|
//
|
|
// Purpose: Implementation of vgui::TextImage control
|
|
//
|
|
// $NoKeywords: $
|
|
//=============================================================================//
|
|
|
|
#include <string.h>
|
|
#include <stdio.h>
|
|
#include <ctype.h>
|
|
#include <assert.h>
|
|
#include <malloc.h>
|
|
|
|
#include <vgui/IPanel.h>
|
|
#include <vgui/ISurface.h>
|
|
#include <vgui/IScheme.h>
|
|
#include <vgui/IInput.h>
|
|
#include <vgui/ILocalize.h>
|
|
#include <KeyValues.h>
|
|
|
|
#include <vgui_controls/TextImage.h>
|
|
#include <vgui_controls/Controls.h>
|
|
|
|
#include "tier0/dbg.h"
|
|
// memdbgon must be the last include file in a .cpp file!!!
|
|
#include <tier0/memdbgon.h>
|
|
|
|
// enable this define if you want unlocalized strings logged to files unfound.txt and unlocalized.txt
|
|
// #define LOG_UNLOCALIZED_STRINGS
|
|
|
|
using namespace vgui;
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Constructor
|
|
//-----------------------------------------------------------------------------
|
|
TextImage::TextImage(const char *text) : Image()
|
|
{
|
|
_utext = NULL;
|
|
_textBufferLen = 0;
|
|
_font = INVALID_FONT;
|
|
_unlocalizedTextSymbol = INVALID_STRING_INDEX;
|
|
_drawWidth = 0;
|
|
_textBufferLen = 0;
|
|
_textLen = 0;
|
|
m_bWrap = false;
|
|
m_LineBreaks.RemoveAll();
|
|
m_pwszEllipsesPosition = NULL;
|
|
|
|
SetText(text); // set the text.
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Constructor
|
|
//-----------------------------------------------------------------------------
|
|
TextImage::TextImage(const wchar_t *wszText) : Image()
|
|
{
|
|
_utext = NULL;
|
|
_textBufferLen = 0;
|
|
_font = INVALID_FONT;
|
|
_unlocalizedTextSymbol = INVALID_STRING_INDEX;
|
|
_drawWidth = 0;
|
|
_textBufferLen = 0;
|
|
_textLen = 0;
|
|
m_bWrap = false;
|
|
m_LineBreaks.RemoveAll();
|
|
SetText(wszText); // set the text.
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Destructor
|
|
//-----------------------------------------------------------------------------
|
|
TextImage::~TextImage()
|
|
{
|
|
delete [] _utext;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: takes the string and looks it up in the localization file to convert it to unicode
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::SetText(const char *text)
|
|
{
|
|
if (!text)
|
|
{
|
|
text = "";
|
|
}
|
|
|
|
// check for localization
|
|
if (*text == '#')
|
|
{
|
|
// try lookup in localization tables
|
|
_unlocalizedTextSymbol = localize()->FindIndex(text + 1);
|
|
|
|
if (_unlocalizedTextSymbol != INVALID_STRING_INDEX)
|
|
{
|
|
wchar_t *unicode = localize()->GetValueByIndex(_unlocalizedTextSymbol);
|
|
SetText(unicode);
|
|
return;
|
|
}
|
|
else
|
|
{
|
|
// could not find string
|
|
// debug code for logging unlocalized strings
|
|
#if defined(LOG_UNLOCALIZED_STRINGS)
|
|
if (*text)
|
|
{
|
|
// write out error to unfound.txt log file
|
|
static bool first = true;
|
|
FILE *f;
|
|
if (first)
|
|
{
|
|
first = false;
|
|
f = fopen("unfound.txt", "wt");
|
|
}
|
|
else
|
|
{
|
|
f = fopen("unfound.txt", "at");
|
|
}
|
|
|
|
if (f)
|
|
{
|
|
fprintf(f, "\"%s\"\n", text);
|
|
fclose(f);
|
|
}
|
|
}
|
|
#endif // LOG_UNLOCALIZED_STRINGS
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// debug code for logging unlocalized strings
|
|
#if defined(LOG_UNLOCALIZED_STRINGS)
|
|
if (text[0])
|
|
{
|
|
// setting a label to be ANSI text, write out error to unlocalized.txt log file
|
|
static bool first = true;
|
|
FILE *f;
|
|
if (first)
|
|
{
|
|
first = false;
|
|
f = fopen("unlocalized.txt", "wt");
|
|
}
|
|
else
|
|
{
|
|
f = fopen("unlocalized.txt", "at");
|
|
}
|
|
if (f)
|
|
{
|
|
fprintf(f, "\"%s\"\n", text);
|
|
fclose(f);
|
|
}
|
|
}
|
|
#endif // LOG_UNLOCALIZED_STRINGS
|
|
}
|
|
|
|
// convert the ansi string to unicode and use that
|
|
wchar_t unicode[1024];
|
|
localize()->ConvertANSIToUnicode(text, unicode, sizeof(unicode));
|
|
SetText(unicode);
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Sets the width that the text can be.
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::SetDrawWidth(int width)
|
|
{
|
|
_drawWidth = width;
|
|
m_bRecalculateTruncation = true;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Gets the width that the text can be.
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::GetDrawWidth(int &width)
|
|
{
|
|
width = _drawWidth;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: sets unicode text directly
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::SetText(const wchar_t *unicode)
|
|
{
|
|
if (!unicode)
|
|
{
|
|
unicode = L"";
|
|
}
|
|
|
|
// reallocate the buffer if necessary
|
|
_textLen = (short)wcslen(unicode);
|
|
if (_textLen >= _textBufferLen)
|
|
{
|
|
delete [] _utext;
|
|
_textBufferLen = (short)(_textLen + 1);
|
|
_utext = new wchar_t[_textBufferLen];
|
|
}
|
|
|
|
m_LineBreaks.RemoveAll();
|
|
|
|
// store the text as unicode
|
|
wcscpy(_utext, unicode);
|
|
m_bRecalculateTruncation = true;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Gets the text in the textImage
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::GetText(char *buffer, int bufferSize)
|
|
{
|
|
localize()->ConvertUnicodeToANSI(_utext, buffer, bufferSize);
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Gets the text in the textImage
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::GetText(wchar_t *buffer, int bufLenInBytes)
|
|
{
|
|
wcsncpy(buffer, _utext, bufLenInBytes / sizeof(wchar_t));
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: data accessor
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::GetUnlocalizedText(char *buffer, int bufferSize)
|
|
{
|
|
if (_unlocalizedTextSymbol != INVALID_STRING_INDEX)
|
|
{
|
|
const char *text = localize()->GetNameByIndex(_unlocalizedTextSymbol);
|
|
buffer[0] = '#';
|
|
Q_strncpy(buffer + 1, text, bufferSize - 1);
|
|
buffer[bufferSize-1] = 0;
|
|
}
|
|
else
|
|
{
|
|
GetText(buffer, bufferSize);
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: unlocalized text symbol
|
|
//-----------------------------------------------------------------------------
|
|
StringIndex_t TextImage::GetUnlocalizedTextSymbol()
|
|
{
|
|
return _unlocalizedTextSymbol;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Changes the current font
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::SetFont(HFont font)
|
|
{
|
|
_font = font;
|
|
m_bRecalculateTruncation = true;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Gets the font of the text.
|
|
//-----------------------------------------------------------------------------
|
|
HFont TextImage::GetFont()
|
|
{
|
|
return _font;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Sets the size of the TextImage. This is directly tied to drawWidth
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::SetSize(int wide, int tall)
|
|
{
|
|
Image::SetSize(wide, tall);
|
|
_drawWidth = wide;
|
|
m_bRecalculateTruncation = true;
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Draw the Image on screen.
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::Paint()
|
|
{
|
|
int wide, tall;
|
|
GetSize(wide, tall);
|
|
|
|
if (!_utext || _font == INVALID_FONT )
|
|
return;
|
|
|
|
if (m_bRecalculateTruncation)
|
|
{
|
|
RecalculateEllipsesPosition();
|
|
}
|
|
|
|
DrawSetTextColor(GetColor());
|
|
HFont font = GetFont();
|
|
DrawSetTextFont(font);
|
|
|
|
int lineHeight = surface()->GetFontTall(font);
|
|
int x = 0, y = 0;
|
|
|
|
int px, py;
|
|
GetPos(px, py);
|
|
|
|
int currentLineBreak = 0;
|
|
|
|
for (wchar_t *wsz = _utext; *wsz != 0; wsz++)
|
|
{
|
|
wchar_t ch = wsz[0];
|
|
|
|
// check for special characters
|
|
if (ch == '\r')
|
|
{
|
|
// ignore, just use \n for newlines
|
|
continue;
|
|
}
|
|
else if (ch == '\n')
|
|
{
|
|
// newline
|
|
x = 0;
|
|
y += lineHeight;
|
|
continue;
|
|
}
|
|
else if (ch == '&')
|
|
{
|
|
// "&&" means draw a single ampersand, single one is a shortcut character
|
|
if (wsz[1] == '&')
|
|
{
|
|
// just move on and draw the second ampersand
|
|
wsz++;
|
|
}
|
|
else
|
|
{
|
|
// draw the underline, then continue to the next character without moving forward
|
|
#ifdef VGUI_DRAW_HOTKEYS_ENABLED
|
|
DrawPrintChar(x + px, y + py, '_');
|
|
#endif
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// see if we've hit the truncated portion of the string
|
|
if (wsz == m_pwszEllipsesPosition)
|
|
{
|
|
// string is truncated, draw ellipses
|
|
for (int i = 0; i < 3; i++)
|
|
{
|
|
surface()->DrawSetTextPos(x + px, y + py);
|
|
surface()->DrawUnicodeChar('.');
|
|
x += surface()->GetCharacterWidth(font, '.');
|
|
}
|
|
break;
|
|
}
|
|
|
|
if (currentLineBreak != m_LineBreaks.Count())
|
|
{
|
|
if (wsz == m_LineBreaks[currentLineBreak])
|
|
{
|
|
x = 0;
|
|
y += lineHeight;
|
|
currentLineBreak++;
|
|
}
|
|
}
|
|
|
|
if (ch != ' ')
|
|
{
|
|
// render the character
|
|
surface()->DrawSetTextPos(x + px, y + py);
|
|
surface()->DrawUnicodeChar(ch);
|
|
}
|
|
x += surface()->GetCharacterWidth(font, ch);
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Get the size of a text string in pixels
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::GetTextSize(int &wide, int &tall)
|
|
{
|
|
wide = 0;
|
|
tall = 0;
|
|
int maxWide = 0;
|
|
const wchar_t *text = _utext;
|
|
|
|
HFont font = GetFont();
|
|
if ( font == INVALID_FONT )
|
|
return;
|
|
|
|
if ( m_bWrap )
|
|
RecalculateNewLinePositions();
|
|
|
|
tall = surface()->GetFontTall(font);
|
|
|
|
int textLen = wcslen(text);
|
|
for (int i = 0; i < textLen; i++)
|
|
{
|
|
// handle stupid special characters, these should be removed
|
|
if (text[i] == '&' && text[i + 1] != 0)
|
|
{
|
|
i++;
|
|
}
|
|
|
|
int a, b, c;
|
|
surface()->GetCharABCwide(font, text[i], a, b, c);
|
|
wide += (a + b + c);
|
|
|
|
if (text[i] == '\n')
|
|
{
|
|
tall += surface()->GetFontTall(font);
|
|
if(wide>maxWide)
|
|
{
|
|
maxWide=wide;
|
|
}
|
|
wide=0; // new line, wide is reset...
|
|
}
|
|
|
|
if ( m_bWrap )
|
|
{
|
|
for(int j=0; j<m_LineBreaks.Count(); j++)
|
|
{
|
|
if ( &text[i] == m_LineBreaks[j] )
|
|
{
|
|
tall += surface()->GetFontTall(font);
|
|
if(wide>maxWide)
|
|
{
|
|
maxWide=wide;
|
|
}
|
|
wide=0; // new line, wide is reset...
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
if (wide < maxWide)
|
|
{
|
|
// maxWide only gets set if a newline is in the label
|
|
wide = maxWide;
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Get the size of the text in the image
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::GetContentSize(int &wide, int &tall)
|
|
{
|
|
GetTextSize(wide, tall);
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Resize the text image to the content size
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::ResizeImageToContent()
|
|
{
|
|
int wide, tall;
|
|
GetContentSize(wide, tall);
|
|
SetSize(wide, tall);
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Recalculates line breaks
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::RecalculateNewLinePositions()
|
|
{
|
|
HFont font = _font;
|
|
|
|
int charWidth;
|
|
int x = 0;
|
|
|
|
//int wordStartIndex = 0;
|
|
wchar_t *wordStartIndex = _utext;
|
|
int wordLength = 0;
|
|
bool hasWord = false;
|
|
bool justStartedNewLine = true;
|
|
bool wordStartedOnNewLine = true;
|
|
|
|
int startChar = 0;
|
|
|
|
// clear the line breaks list
|
|
m_LineBreaks.RemoveAll();
|
|
|
|
// handle the case where this char is a new line, in that case
|
|
// we have already taken its break index into account above so skip it.
|
|
if (_utext[startChar] == '\r' || _utext[startChar] == '\n')
|
|
{
|
|
startChar++;
|
|
}
|
|
|
|
// loop through all the characters
|
|
for (wchar_t *wsz = &_utext[startChar]; *wsz != 0; wsz++)
|
|
{
|
|
wchar_t ch = wsz[0];
|
|
|
|
// line break only on whitespace characters
|
|
if (!iswspace(ch))
|
|
{
|
|
if ( !hasWord )
|
|
{
|
|
// Start a new word
|
|
wordStartIndex = wsz;
|
|
hasWord = true;
|
|
wordStartedOnNewLine = justStartedNewLine;
|
|
wordLength = 0;
|
|
}
|
|
//else append to the current word
|
|
}
|
|
else
|
|
{
|
|
// whitespace/punctuation character
|
|
// end the word
|
|
hasWord = false;
|
|
}
|
|
|
|
// get the width
|
|
charWidth = surface()->GetCharacterWidth(font, ch);
|
|
if (!iswcntrl(ch))
|
|
{
|
|
justStartedNewLine = false;
|
|
}
|
|
|
|
// check to see if the word is past the end of the line [wordStartIndex, i)
|
|
if ((x + charWidth) > _drawWidth || ch == '\r' || ch == '\n')
|
|
{
|
|
justStartedNewLine = true;
|
|
hasWord = false;
|
|
|
|
if (ch == '\r' || ch == '\n')
|
|
{
|
|
// set the break at the current character
|
|
//don't do this, paint will manually wrap on newline chars
|
|
// m_LineBreaks.AddToTail(i);
|
|
}
|
|
else if (wordStartedOnNewLine)
|
|
{
|
|
// word is longer than a line, so set the break at the current cursor
|
|
m_LineBreaks.AddToTail(wsz);
|
|
}
|
|
else
|
|
{
|
|
// set it at the last word Start
|
|
m_LineBreaks.AddToTail(wordStartIndex);
|
|
|
|
// just back to reparse the next line of text
|
|
wsz = wordStartIndex;
|
|
}
|
|
|
|
// reset word length
|
|
wordLength = 0;
|
|
x = 0;
|
|
continue;
|
|
}
|
|
|
|
// add to the size
|
|
x += charWidth;
|
|
wordLength += charWidth;
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// Purpose: Calculates where the text should be truncated
|
|
//-----------------------------------------------------------------------------
|
|
void TextImage::RecalculateEllipsesPosition()
|
|
{
|
|
m_pwszEllipsesPosition = NULL;
|
|
m_bRecalculateTruncation = false;
|
|
|
|
//don't insert ellipses on wrapped strings
|
|
if ( m_bWrap )
|
|
return;
|
|
|
|
// don't truncate strings with newlines
|
|
if (wcschr(_utext, '\n') != NULL)
|
|
return;
|
|
|
|
HFont font = GetFont();
|
|
int ellipsesWidth = 3 * surface()->GetCharacterWidth(font, '.');
|
|
int x = 0;
|
|
|
|
for (wchar_t *wsz = _utext; *wsz != 0; wsz++)
|
|
{
|
|
wchar_t ch = wsz[0];
|
|
|
|
// check for special characters
|
|
if (ch == '\r')
|
|
{
|
|
// ignore, just use \n for newlines
|
|
continue;
|
|
}
|
|
else if (ch == '&')
|
|
{
|
|
// "&&" means draw a single ampersand, single one is a shortcut character
|
|
if (wsz[1] == '&')
|
|
{
|
|
// just move on and draw the second ampersand
|
|
wsz++;
|
|
}
|
|
else
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// don't truncate the first character
|
|
if (wsz == _utext)
|
|
continue;
|
|
|
|
int len = surface()->GetCharacterWidth(font, ch);
|
|
if (x + len + ellipsesWidth > _drawWidth)
|
|
{
|
|
// potential have an ellipses, see if the remaining characters will fit
|
|
int remainingLength = len;
|
|
for (const wchar_t *rwsz = wsz + 1; *rwsz != 0; rwsz++)
|
|
{
|
|
remainingLength += surface()->GetCharacterWidth(font, *rwsz);
|
|
}
|
|
|
|
if (x + remainingLength > _drawWidth)
|
|
{
|
|
// looks like we've got an ellipses situation
|
|
m_pwszEllipsesPosition = wsz;
|
|
break;
|
|
}
|
|
}
|
|
|
|
x += len;
|
|
}
|
|
}
|
|
|
|
void TextImage::SetWrap( bool bWrap )
|
|
{
|
|
m_bWrap = bWrap;
|
|
}
|