doxygen: add newline after \file
[blender.git] / source / blender / blenlib / BLI_string_cursor_utf8.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2011 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_STRING_CURSOR_UTF8_H__
21 #define __BLI_STRING_CURSOR_UTF8_H__
22
23 /** \file
24  * \ingroup bli
25  */
26
27 typedef enum eStrCursorJumpType {
28         STRCUR_JUMP_NONE,
29         STRCUR_JUMP_DELIM,
30         STRCUR_JUMP_ALL
31 } eStrCursorJumpType;
32
33 typedef enum eStrCursorJumpDirection {
34         STRCUR_DIR_PREV,
35         STRCUR_DIR_NEXT
36 } eStrCursorJumpDirection;
37
38 bool BLI_str_cursor_step_next_utf8(const char *str, size_t maxlen, int *pos);
39 bool BLI_str_cursor_step_prev_utf8(const char *str, size_t maxlen, int *pos);
40
41 void BLI_str_cursor_step_utf8(
42         const char *str, size_t maxlen,
43         int *pos, eStrCursorJumpDirection direction,
44         eStrCursorJumpType jump, bool use_init_step);
45
46 void BLI_str_cursor_step_wchar(
47         const wchar_t *str, size_t maxlen,
48         int *pos, eStrCursorJumpDirection direction,
49         eStrCursorJumpType jump, bool use_init_step);
50
51 #endif /* __BLI_STRING_CURSOR_UTF8_H__ */