File: vtkTextCodecFactory.h

package info (click to toggle)
vtk6 6.3.0%2Bdfsg2-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 118,880 kB
  • sloc: cpp: 1,442,792; ansic: 113,395; python: 72,383; tcl: 46,998; xml: 8,119; yacc: 4,525; java: 4,239; perl: 3,108; lex: 1,694; sh: 1,093; asm: 154; makefile: 103; objc: 17
file content (97 lines) | stat: -rw-r--r-- 3,462 bytes parent folder | download | duplicates (4)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*=========================================================================

Program:   Visualization Toolkit
Module:    vtkTextCodecFactory.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.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
// .NAME vtkTextCodecFactory - maintain a list of text codecs and return instances
//
// .SECTION Description
// A single class to hold registered codecs and return instances of them based
// on either a decriptive name (UTF16 or latin-1) or by asking who can handle a
// given std::vector<unsigned char>
//
// .SECTION Thanks
// Thanks to Tim Shed from Sandia National Laboratories for his work
// on the concepts and to Marcus Hanwell and Jeff Baumes of Kitware for
// keeping me out of the weeds
//
// .SECTION See Also
// vtkTextCodec
//

#ifndef vtkTextCodecFactory_h
#define vtkTextCodecFactory_h

#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"

class vtkTextCodec;

class VTKIOCORE_EXPORT vtkTextCodecFactory : public vtkObject
{
public:
  vtkTypeMacro(vtkTextCodecFactory, vtkObject);
  static vtkTextCodecFactory* New() ;
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Type for Creation callback.
  typedef vtkTextCodec* (*CreateFunction)();

  // Description:
  // Provides mechanism to register/unregister additional callbacks to create
  // concrete subclasses of vtkTextCodecFactory to handle different protocols.
  // The registered callbacks are tried in the order they are registered.
  static void RegisterCreateCallback(CreateFunction callback);
  static void UnRegisterCreateCallback(CreateFunction callback);
  static void UnRegisterAllCreateCallbacks();

  // Description:
  // Given a codec/storage name try to find one of our registered codecs that
  // can handle it.  This is non-deterministic, very messy and should not be
  // your first thing to try.
  // The registered callbacks are tried in the order they are registered.
  static vtkTextCodec* CodecForName(const char* CodecName);

  // Description:
  // Given a snippet of the stored data name try to find one of our registered
  // codecs that can handle transforming it into unicode.
  // The registered callbacks are tried in the order they are registered.
  static vtkTextCodec* CodecToHandle(istream& InputStream);

  // Description:
  // Initialize core text codecs - needed for the static compilation case.
  static void Initialize();

//BTX
protected:
  vtkTextCodecFactory();
  ~vtkTextCodecFactory();

private:
  vtkTextCodecFactory(const vtkTextCodecFactory &); // Not implemented.
  void operator=(const vtkTextCodecFactory &); // Not implemented.

  // Description;
  // Data structure used to store registered callbacks.
  class CallbackVector;
  static CallbackVector* Callbacks;

//ETX
};

#endif // vtkTextCodecFactory_h