vtkWrapText.h 1.77 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkWrapText.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

/**
 * vtkWrap provides useful functions for generating wrapping code.
*/

#ifndef VTK_WRAP_TEXT_H
#define VTK_WRAP_TEXT_H

#include "vtkParse.h"
#include "vtkParseHierarchy.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Quote a string for inclusion in a C string literal.  The "maxlen"
 * should be set to a value between 32 and 2047.  Values over 2047
 * will result in string literals too long for some compilers.  If
 * the string is truncated, a "..." will be appended.
 */
const char *vtkWrapText_QuoteString(const char *comment, size_t maxlen);

/**
 * Format a doxygen comment for plain text, and word-wrap at
 * the specified width.  A 70-char width is recommended.
 */
const char *vtkWrapText_FormatComment(const char *comment, size_t width);

/**
 * Format a method signature by applying word-wrap at the specified
 * width and taking special care not to split any literals or names.
 * A width of 70 chars is recommended.
 */
const char *vtkWrapText_FormatSignature(
  const char *signature, size_t width, size_t maxlen);

/**
 * Produce a python signature for a method, for use in documentation.
 */
const char *vtkWrapText_PythonSignature(FunctionInfo *currentFunction);

#ifdef __cplusplus
}
#endif

#endif