xref: /petsc/src/sys/totalview/tv_data_display.h (revision 9371c9d470a9602b6d10a8bf50c9b2280a79e45a)
1 /*
2  * $Header: /home/tv/src/debugger/src/datadisp/tv_data_display.h,v 1.3 2010-04-21 15:32:50 tringali Exp $
3  * $Locker:  $
4 
5    Copyright (c) 2010, Rogue Wave Software, Inc.
6 
7    Permission is hereby granted, free of charge, to any person obtaining a copy
8    of this software and associated documentation files (the "Software"), to deal
9    in the Software without restriction, including without limitation the rights
10    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11    copies of the Software, and to permit persons to whom the Software is
12    furnished to do so, subject to the following conditions:
13 
14    The above copyright notice and this permission notice shall be included in
15    all copies or substantial portions of the Software.
16 
17    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23    THE SOFTWARE.
24 
25  * Update log
26  *
27  * Sep 25 2009 SJT: Add idempotence header.
28  * Jul 1  2009 SJT: Created.
29  *
30  */
31 
32 #if !defined(TV_DATA_DISPLAY_H_INCLUDED)
33 #define TV_DATA_DISPLAY_H_INCLUDED 1
34 
35 #include <petscsys.h>
36 
37 #if defined(__cplusplus)
38 extern "C" {
39 #endif
40 
41 enum TV_format_result {
42   TV_format_OK,     /* Type is known, and successfully converted */
43   TV_format_failed, /* Type is known, but could not convert it */
44   TV_format_raw,    /* Just display it as a regular type for now */
45   TV_format_never   /* Don't know about this type, and please don't ask again */
46 };
47 
48 #define TV_ascii_string_type "$string"
49 #define TV_int_type          "$int"
50 
51 PETSC_EXTERN int TV_add_row(const char *, const char *, const void *);
52 
53 /*
54        0: Success
55    EPERM: Called with no active callback to TV_display_type
56   EINVAL: field_name or type_name has illegal characters
57   ENOMEM: No more room left for display data
58 */
59 
60 #if defined(__cplusplus)
61 }
62 #endif
63 
64 #endif
65