amxmodx/third_party/utf8rewind/internal/decomposition.c
Vincent Herbet ab854ec035 Improve UTF-8 support in some natives (bug 6475) (#407)
* Compile as static library, update AMBuildScript and link to core

* Update VS project files to include the library

* Add UTF-8 Rewind library (v1.5.1) to third_party directory

* Update ACKNOWLEDGEMENTS.txt

* Move AMXX buffer in its own function

* Move constants from string.inc to string_const.inc and update project files

* Move stocks from string.inc to string_stocks.inc and update project files

* Improve UTF-8 support in containi() and update documentation

* Improve UTF-8 support in strcmp() and update documentation

* Improve UTF-8 support in strfind() and update documentation

Worth to be noted that this native with ignorecase set was not working properly. So broken that no one reported the issue.
This adds also a safety check for "pos" parameter to not go < 0.

* Improve UTF-8 support in strncmp() and update documentation

* Improve UTF-8 support in equali() and update documentation

* Add an option to some UTF-8 Rewind functions for avoiding invalid data to be replaced

By default it replaces any invalid byte or sequence of bytes by 0xFFFD (3 bytes). It can be problematic when the input buffer is not changed (from a plugin) and that some natives need to calculate a position from the converted string. With such replacement, the position is displaced due the final string length being larger.

This compiles the library as C++, because I added some silly param with a default default value which is not supported by C.

* Improve UTF-8 support in replace_string/ex() and update documentation

* Add is_string_category() and update documentation

* Update a little testsuite plugin (and fix linux compilation)

* Add mb_strotolower/upper() and update documentation

* Add mb_ucfirst() and update documentation

* Add mb_strtotile() and update documentation

* Improve UTF-8 support in get_players() and find_player() with name/case insenstive flags set

* Fix KliPPy's complain
2017-08-05 10:32:16 +02:00

339 lines
8.3 KiB
C

/*
Copyright (C) 2014-2016 Quinten Lansu
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/
#include "decomposition.h"
#include "codepoint.h"
#include "database.h"
uint8_t decompose_initialize(
DecomposeState* state,
StreamState* input, StreamState* output,
uint8_t compatibility)
{
memset(state, 0, sizeof(DecomposeState));
/* Ensure streams are valid */
if (input == 0 ||
output == 0)
{
return 0;
}
/* Set up streams */
state->input = input;
state->output = output;
memset(state->output, 0, sizeof(StreamState));
/* Set up codepoint quickcheck property */
if (compatibility == 1)
{
state->property_index1 = NFKDIndex1Ptr;
state->property_index2 = NFKDIndex2Ptr;
state->property_data = NFKDDataPtr;
state->qc_index = QuickCheckNFKDIndexPtr;
state->qc_data = QuickCheckNFKDDataPtr;
}
else
{
state->property_index1 = NFDIndex1Ptr;
state->property_index2 = NFDIndex2Ptr;
state->property_data = NFDDataPtr;
state->qc_index = QuickCheckNFDIndexPtr;
state->qc_data = QuickCheckNFDDataPtr;
}
return 1;
}
uint8_t decompose_execute(DecomposeState* state)
{
unicode_t* src_codepoint;
unicode_t* dst_codepoint;
uint8_t* dst_canonical_combining_class;
uint8_t* dst_quick_check;
uint8_t uncached = 1;
/* Check if input is valid */
if (state->input == 0)
{
return 0;
}
/* Set up output */
state->output->current = 0;
state->output->index = 0;
state->output->stable = 1;
dst_codepoint = state->output->codepoint;
dst_canonical_combining_class = state->output->canonical_combining_class;
dst_quick_check = state->output->quick_check;
/* Check cache for stored sequences */
if (state->cache_current < state->cache_filled)
{
/* Read from cache */
while (state->cache_current < state->cache_filled)
{
if (state->output->current > 0 &&
state->cache_canonical_combining_class[state->cache_current] == CCC_NOT_REORDERED)
{
/* Sequence ends on next non-starter or end of data */
break;
}
*dst_codepoint++ = state->cache_codepoint[state->cache_current];
*dst_canonical_combining_class++ = state->cache_canonical_combining_class[state->cache_current];
*dst_quick_check++ = QuickCheckResult_Yes;
state->output->current++;
state->cache_current++;
}
/* Check if cache has been emptied */
if (state->cache_current == state->cache_filled)
{
state->cache_current = 0;
state->cache_filled = 0;
}
/* Check for additional input */
if (state->input->index == state->input->current)
{
/* Don't compare canonical combining classes, output will always be stable */
return state->output->current;
}
}
/* Read next sequence from input */
if (state->input->index == state->input->current &&
!stream_read(state->input, state->qc_index, state->qc_data))
{
/* End of data */
state->input = 0;
return 0;
}
/* Read from source */
src_codepoint = state->input->codepoint + state->input->index;
while (state->input->index < state->input->current)
{
if (*src_codepoint <= MAX_BASIC_LATIN)
{
/* Basic Latin codepoints are already decomposed */
if (uncached)
{
*dst_codepoint++ = *src_codepoint;
*dst_canonical_combining_class++ = CCC_NOT_REORDERED;
*dst_quick_check++ = QuickCheckResult_Yes;
state->output->current++;
}
else
{
state->cache_codepoint[state->cache_filled] = *src_codepoint;
state->cache_canonical_combining_class[state->cache_filled] = CCC_NOT_REORDERED;
state->cache_filled++;
}
}
else if (
*src_codepoint >= HANGUL_S_FIRST &&
*src_codepoint <= HANGUL_S_LAST)
{
/*
Hangul decomposition
Algorithm adapted from Unicode Technical Report #15:
http://www.unicode.org/reports/tr15/tr15-18.html#Hangul
*/
unicode_t s_index = *src_codepoint - HANGUL_S_FIRST;
if (uncached)
{
*dst_codepoint++ = HANGUL_L_FIRST + (s_index / HANGUL_N_COUNT);
*dst_canonical_combining_class++ = CCC_NOT_REORDERED;
*dst_quick_check++ = QuickCheckResult_Yes;
state->output->current++;
}
else
{
state->cache_codepoint[state->cache_filled] = HANGUL_L_FIRST + (s_index / HANGUL_N_COUNT);
state->cache_canonical_combining_class[state->cache_filled] = CCC_NOT_REORDERED;
state->cache_filled++;
}
/* Store subsequent non-starters in cache */
uncached = 0;
state->cache_codepoint[state->cache_filled] = HANGUL_V_FIRST + (s_index % HANGUL_N_COUNT) / HANGUL_T_COUNT;
state->cache_canonical_combining_class[state->cache_filled] = CCC_NOT_REORDERED;
state->cache_filled++;
if ((s_index % HANGUL_T_COUNT) != 0)
{
state->cache_codepoint[state->cache_filled] = HANGUL_T_FIRST + (s_index % HANGUL_T_COUNT);
state->cache_canonical_combining_class[state->cache_filled] = CCC_NOT_REORDERED;
state->cache_filled++;
}
}
else
{
/* Use quick check to skip stable codepoints */
unicode_t decoded_codepoint = *src_codepoint;
uint8_t decoded_quick_check = PROPERTY_GET(state->qc_index, state->qc_data, decoded_codepoint);
uint8_t decoded_canonical_combining_class;
uint8_t decoded_size;
if (decoded_quick_check != QuickCheckResult_Yes)
{
/* Check database for decomposition */
uint8_t src_size;
const char* src = database_querydecomposition(
decoded_codepoint,
state->property_index1, state->property_index2, state->property_data,
&src_size);
while (src_size > 0)
{
/* Decode current codepoint */
decoded_size = codepoint_read(src, src_size, &decoded_codepoint);
if (decoded_size == 0)
{
break;
}
decoded_canonical_combining_class = PROPERTY_GET_CCC(decoded_codepoint);
/* Check for end of sequence */
if (uncached &&
state->output->current > 0 &&
decoded_canonical_combining_class == CCC_NOT_REORDERED)
{
uncached = 0;
}
if (uncached)
{
/* Write codepoint to output */
*dst_codepoint++ = decoded_codepoint;
*dst_canonical_combining_class++ = decoded_canonical_combining_class;
*dst_quick_check++ = QuickCheckResult_Yes;
state->output->current++;
}
else
{
/* Store in cache */
state->cache_codepoint[state->cache_filled] = decoded_codepoint;
state->cache_canonical_combining_class[state->cache_filled] = decoded_canonical_combining_class;
state->cache_filled++;
}
src += decoded_size;
src_size -= decoded_size;
}
}
else
{
decoded_canonical_combining_class = PROPERTY_GET_CCC(decoded_codepoint);
if (uncached)
{
/* Write codepoint to output */
*dst_codepoint++ = decoded_codepoint;
*dst_canonical_combining_class++ = decoded_canonical_combining_class;
*dst_quick_check++ = decoded_quick_check;
state->output->current++;
}
else
{
/* Store in cache */
state->cache_codepoint[state->cache_filled] = decoded_codepoint;
state->cache_canonical_combining_class[state->cache_filled] = decoded_canonical_combining_class;
state->cache_filled++;
}
}
}
src_codepoint++;
state->input->index++;
}
if (state->output->current > 1)
{
/* Check if output is stable by comparing canonical combining classes */
uint8_t i;
for (i = 1; i < state->output->current; ++i)
{
if (state->output->canonical_combining_class[i] < state->output->canonical_combining_class[i - 1])
{
state->output->stable = 0;
break;
}
}
}
return state->output->current;
}