Move all intro related stuff to the intro file
[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 /* The file to be imported. */
27 struct file
28   {
29     char *file_name;        /* File name. */
30
31     /* Relevant only for text files */
32
33     gchar *encoding;        /* Encoding. */
34     unsigned long int total_lines; /* Number of lines in file. */
35     bool total_is_exact;    /* Is total_lines exact (or an estimate)? */
36
37     /* The first several lines of the file. */
38     struct string *lines;
39     size_t line_cnt;
40   };
41
42 /* The main body of the GTK+ assistant and related data. */
43 struct assistant
44   {
45     GtkBuilder *builder;
46     GtkAssistant *assistant;
47     GMainLoop *main_loop;
48     GtkWidget *paste_button;
49     GtkWidget *reset_button;
50     int response;
51     int watch_cursor;
52
53     GtkCellRenderer *prop_renderer;
54     GtkCellRenderer *fixed_renderer;
55   };
56
57
58 /* The sheet_spec page of the assistant (only relevant for spreadsheet imports). */
59 struct sheet_spec_page
60   {
61     GtkWidget *page;
62     struct casereader *reader;
63     struct dictionary *dict;
64     struct spreadsheet *spreadsheet;
65     
66     struct spreadsheet_read_info sri;
67     struct spreadsheet_read_options opts;
68   };
69
70
71 /* Page where the user chooses the first line of data. */
72 struct first_line_page
73   {
74     int skip_lines;    /* Number of initial lines to skip? */
75     bool variable_names; /* Variable names above first line of data? */
76
77     GtkWidget *page;
78     GtkTreeView *tree_view;
79     GtkWidget *variable_names_cb;
80   };
81
82
83 /* Page where the user chooses field separators. */
84 struct separators_page
85   {
86     /* How to break lines into columns. */
87     struct string separators;   /* Field separators. */
88     struct string quotes;       /* Quote characters. */
89     bool escape;                /* Doubled quotes yield a quote mark? */
90
91     /* The columns produced thereby. */
92     struct column *columns;     /* Information about each column. */
93     size_t column_cnt;          /* Number of columns. */
94
95     GtkWidget *page;
96     GtkWidget *custom_cb;
97     GtkWidget *custom_entry;
98     GtkWidget *quote_cb;
99     GtkWidget *quote_combo;
100     GtkEntry *quote_entry;
101     GtkWidget *escape_cb;
102     GtkTreeView *fields_tree_view;
103   };
104
105 /* Page where the user verifies and adjusts input formats. */
106 struct formats_page
107   {
108     struct dictionary *dict;
109
110     GtkWidget *page;
111     GtkTreeView *data_tree_view;
112     PsppireDict *psppire_dict;
113     struct variable **modified_vars;
114     size_t modified_var_cnt;
115   };
116
117
118 struct import_assistant
119   {
120     struct file file;
121     struct assistant asst;
122
123     struct intro_page *intro;
124     struct sheet_spec_page *sheet_spec;
125     struct first_line_page *first_line;
126     struct separators_page *separators;
127     struct formats_page *formats;
128   };
129
130
131
132
133 struct column
134   {
135     /* Variable name for this column.  This is the variable name
136        used on the separators page; it can be overridden by the
137        user on the formats page. */
138     char *name;
139
140     /* Maximum length of any row in this column. */
141     size_t width;
142
143     /* Contents of this column: contents[row] is the contents for
144        the given row.
145
146        A null substring indicates a missing column for that row
147        (because the line contains an insufficient number of
148        separators).
149
150        contents[] elements may be substrings of the lines[]
151        strings that represent the whole lines of the file, to
152        save memory.  Other elements are dynamically allocated
153        with ss_alloc_substring. */
154     struct substring *contents;
155   };
156
157
158 GtkWidget * add_page_to_assistant (struct import_assistant *ia,
159                                    GtkWidget *page, GtkAssistantPageType type);
160
161 void text_data_import_assistant (PsppireDataWindow *);
162
163 /* FIXME: Should this be private to first line page ? */
164 void make_tree_view (const struct import_assistant *ia,
165                             size_t first_line,
166                             GtkTreeView **tree_view);
167
168 gint get_monospace_width (GtkTreeView *, GtkCellRenderer *,
169                                  size_t char_cnt);
170 gint get_string_width (GtkTreeView *, GtkCellRenderer *,
171                               const char *string);
172
173
174
175 void push_watch_cursor (struct import_assistant *);
176 void pop_watch_cursor (struct import_assistant *);
177
178
179 GtkTreeView *create_data_tree_view (bool input, GtkContainer *parent,
180                                            struct import_assistant *);
181
182 GtkTreeViewColumn *make_data_column (struct import_assistant *,
183                                             GtkTreeView *, bool input,
184                                             gint column_idx);
185
186
187 void  update_assistant (struct import_assistant *ia);
188
189 bool init_file (struct import_assistant *ia, GtkWindow *parent_window);
190 void destroy_file (struct import_assistant *ia);
191
192
193 void init_sheet_spec_page (struct import_assistant *);
194 void prepare_sheet_spec_page (struct import_assistant *ia);
195 void reset_sheet_spec_page (struct import_assistant *);
196 void post_sheet_spec_page (struct import_assistant *ia);
197
198 void init_first_line_page (struct import_assistant *ia);
199 void prepare_first_line_page (struct import_assistant *ia);
200 void reset_first_line_page (struct import_assistant *);
201
202 void init_separators_page (struct import_assistant *ia);
203 void prepare_separators_page (struct import_assistant *ia);
204 void reset_separators_page (struct import_assistant *);
205 void destroy_separators_page (struct import_assistant *ia);
206
207 void init_formats_page (struct import_assistant *ia);
208 void prepare_formats_page (struct import_assistant *ia);
209 void reset_formats_page (struct import_assistant *);
210 void destroy_formats_page (struct import_assistant *ia);
211
212 struct import_assistant * init_assistant (GtkWindow *);
213 void destroy_assistant (struct import_assistant *);
214
215
216 #endif