thodg/libgit2/src/win32/utf-conv.h

• Show log

  Commit

• Hash : 0c7f49dd
  Author :
  Date : 2017-06-30T13:39:01
  

  Make sure to always include "common.h" first
  
  Next to including several files, our "common.h" header also declares
  various macros which are then used throughout the project. As such, we
  have to make sure to always include this file first in all
  implementation files. Otherwise, we might encounter problems or even
  silent behavioural differences due to macros or defines not being
  defined as they should be. So in fact, our header and implementation
  files should make sure to always include "common.h" first.
  
  This commit does so by establishing a common include pattern. Header
  files inside of "src" will now always include "common.h" as its first
  other file, separated by a newline from all the other includes to make
  it stand out as special. There are two cases for the implementation
  files. If they do have a matching header file, they will always include
  this one first, leading to "common.h" being transitively included as
  first file. If they do not have a matching header file, they instead
  include "common.h" as first file themselves.
  
  This fixes the outlined problems and will become our standard practice
  for header and source files inside of the "src/" from now on.
  

Download

• src/win32/utf-conv.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef INCLUDE_git_utfconv_h__
  #define INCLUDE_git_utfconv_h__
  
  #include "common.h"
  
  #include <wchar.h>
  
  #ifndef WC_ERR_INVALID_CHARS
  # define WC_ERR_INVALID_CHARS	0x80
  #endif
  
  /**
   * Converts a UTF-8 string to wide characters.
   *
   * @param dest The buffer to receive the wide string.
   * @param dest_size The size of the buffer, in characters.
   * @param src The UTF-8 string to convert.
   * @return The length of the wide string, in characters (not counting the NULL terminator), or < 0 for failure
   */
  int git__utf8_to_16(wchar_t *dest, size_t dest_size, const char *src);
  
  /**
   * Converts a wide string to UTF-8.
   *
   * @param dest The buffer to receive the UTF-8 string.
   * @param dest_size The size of the buffer, in bytes.
   * @param src The wide string to convert.
   * @return The length of the UTF-8 string, in bytes (not counting the NULL terminator), or < 0 for failure
   */
  int git__utf16_to_8(char *dest, size_t dest_size, const wchar_t *src);
  
  /**
   * Converts a UTF-8 string to wide characters.
   * Memory is allocated to hold the converted string.
   * The caller is responsible for freeing the string with git__free.
   *
   * @param dest Receives a pointer to the wide string.
   * @param src The UTF-8 string to convert.
   * @return The length of the wide string, in characters (not counting the NULL terminator), or < 0 for failure
   */
  int git__utf8_to_16_alloc(wchar_t **dest, const char *src);
  
  /**
   * Converts a wide string to UTF-8.
   * Memory is allocated to hold the converted string.
   * The caller is responsible for freeing the string with git__free.
   *
   * @param dest Receives a pointer to the UTF-8 string.
   * @param src The wide string to convert.
   * @return The length of the UTF-8 string, in bytes (not counting the NULL terminator), or < 0 for failure
   */
  int git__utf16_to_8_alloc(char **dest, const wchar_t *src);
  
  #endif
  

Download