formats page: Construction is initialisation
[pspp] / src / ui / gui / text-data-import-dialog.h
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008, 2010, 2011, 2013  Free Software Foundation
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #ifndef TEXT_DATA_IMPORT_DIALOG_H
18 #define TEXT_DATA_IMPORT_DIALOG_H
19
20 #include <glib-object.h>
21 #include "ui/gui/psppire-data-window.h"
22 #include "data/spreadsheet-reader.h"
23
24 #include "libpspp/str.h"
25
26 enum { MAX_PREVIEW_LINES = 1000 }; /* Max number of lines to read. */
27
28 /* The file to be imported. */
29 struct file
30   {
31     char *file_name;        /* File name. */
32
33     /* Relevant only for text files */
34
35     gchar *encoding;        /* Encoding. */
36     unsigned long int total_lines; /* Number of lines in file. */
37     bool total_is_exact;    /* Is total_lines exact (or an estimate)? */
38
39     /* The first several lines of the file. */
40     struct string *lines;
41     size_t line_cnt;
42   };
43
44 /* The main body of the GTK+ assistant and related data. */
45 struct assistant
46   {
47     GtkBuilder *builder;
48     GtkAssistant *assistant;
49     GMainLoop *main_loop;
50     GtkWidget *paste_button;
51     GtkWidget *reset_button;
52     int response;
53     int watch_cursor;
54
55     GtkCellRenderer *prop_renderer;
56     GtkCellRenderer *fixed_renderer;
57   };
58
59 struct import_assistant
60   {
61     struct file file;
62     struct assistant asst;
63
64     struct intro_page *intro;
65     struct sheet_spec_page *sheet_spec;
66     struct first_line_page *first_line;
67     struct separators_page *separators;
68     struct formats_page *formats;
69
70     /* The columns produced. */
71     struct column *columns;     /* Information about each column. */
72     size_t column_cnt;          /* Number of columns. */
73
74     int skip_lines;             /* Number of initial lines to skip? */
75     bool variable_names;        /* Variable names above first line of data? */
76     struct dictionary *dict;
77   };
78
79 struct column
80   {
81     /* Variable name for this column.  This is the variable name
82        used on the separators page; it can be overridden by the
83        user on the formats page. */
84     char *name;
85
86     /* Maximum length of any row in this column. */
87     size_t width;
88
89     /* Contents of this column: contents[row] is the contents for
90        the given row.
91
92        A null substring indicates a missing column for that row
93        (because the line contains an insufficient number of
94        separators).
95
96        contents[] elements may be substrings of the lines[]
97        strings that represent the whole lines of the file, to
98        save memory.  Other elements are dynamically allocated
99        with ss_alloc_substring. */
100     struct substring *contents;
101   };
102
103
104 GtkWidget * add_page_to_assistant (struct import_assistant *ia,
105                                    GtkWidget *page, GtkAssistantPageType type);
106
107 void text_data_import_assistant (PsppireDataWindow *);
108
109 /* FIXME: Should this be private to first line page ? */
110 void make_tree_view (const struct import_assistant *ia,
111                             size_t first_line,
112                             GtkTreeView **tree_view);
113
114 gint get_monospace_width (GtkTreeView *, GtkCellRenderer *,
115                                  size_t char_cnt);
116 gint get_string_width (GtkTreeView *, GtkCellRenderer *,
117                               const char *string);
118
119
120
121 void push_watch_cursor (struct import_assistant *);
122 void pop_watch_cursor (struct import_assistant *);
123
124
125 GtkTreeView *create_data_tree_view (bool input, GtkContainer *parent,
126                                            struct import_assistant *);
127
128 GtkTreeViewColumn *make_data_column (struct import_assistant *,
129                                             GtkTreeView *, bool input,
130                                             gint column_idx);
131
132
133 void  update_assistant (struct import_assistant *ia);
134
135 bool init_file (struct import_assistant *ia, GtkWindow *parent_window);
136 void destroy_file (struct import_assistant *ia);
137
138 void prepare_sheet_spec_page (struct import_assistant *ia);
139 void reset_sheet_spec_page (struct import_assistant *);
140 void post_sheet_spec_page (struct import_assistant *ia);
141
142 void prepare_first_line_page (struct import_assistant *ia);
143 void reset_first_line_page (struct import_assistant *);
144
145 void prepare_separators_page (struct import_assistant *ia);
146 void reset_separators_page (struct import_assistant *);
147 void destroy_separators_page (struct import_assistant *ia);
148
149 void prepare_formats_page (struct import_assistant *ia);
150 void reset_formats_page (struct import_assistant *);
151 void destroy_formats_page (struct import_assistant *ia);
152
153 struct import_assistant * init_assistant (GtkWindow *);
154 void destroy_assistant (struct import_assistant *);
155
156
157 #endif