9e13b65f0af233151835f1bfdad16ec921766976
[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     bool loop_done;
51     GtkWidget *paste_button;
52     GtkWidget *reset_button;
53     int response;
54     int watch_cursor;
55
56     GtkCellRenderer *prop_renderer;
57     GtkCellRenderer *fixed_renderer;
58   };
59
60 struct import_assistant
61   {
62     struct file file;
63     struct assistant asst;
64
65     struct intro_page *intro;
66     struct sheet_spec_page *sheet_spec;
67     struct first_line_page *first_line;
68     struct separators_page *separators;
69     struct formats_page *formats;
70
71     /* The columns produced. */
72     struct column *columns;     /* Information about each column. */
73     size_t column_cnt;          /* Number of columns. */
74
75     int skip_lines;             /* Number of initial lines to skip? */
76     bool variable_names;        /* Variable names above first line of data? */
77     struct dictionary *dict;
78
79     struct spreadsheet *spreadsheet;
80   };
81
82 struct column
83   {
84     /* Variable name for this column.  This is the variable name
85        used on the separators page; it can be overridden by the
86        user on the formats page. */
87     char *name;
88
89     /* Maximum length of any row in this column. */
90     size_t width;
91
92     /* Contents of this column: contents[row] is the contents for
93        the given row.
94
95        A null substring indicates a missing column for that row
96        (because the line contains an insufficient number of
97        separators).
98
99        contents[] elements may be substrings of the lines[]
100        strings that represent the whole lines of the file, to
101        save memory.  Other elements are dynamically allocated
102        with ss_alloc_substring. */
103     struct substring *contents;
104   };
105
106
107 GtkWidget * add_page_to_assistant (struct import_assistant *ia,
108                                    GtkWidget *page, GtkAssistantPageType type);
109
110 void text_data_import_assistant (PsppireDataWindow *);
111
112 /* FIXME: Should this be private to first line page ? */
113 void make_tree_view (const struct import_assistant *ia,
114                             size_t first_line,
115                             PsppSheetView **tree_view);
116
117 gint get_monospace_width (PsppSheetView *, GtkCellRenderer *,
118                                  size_t char_cnt);
119 gint get_string_width (PsppSheetView *, GtkCellRenderer *,
120                               const char *string);
121
122
123
124 void push_watch_cursor (struct import_assistant *);
125 void pop_watch_cursor (struct import_assistant *);
126
127
128 PsppSheetView *create_data_tree_view (bool input, GtkContainer *parent,
129                                       struct import_assistant *);
130
131 PsppSheetViewColumn *make_data_column (struct import_assistant *,
132                                        PsppSheetView *, bool input,
133                                        gint column_idx);
134
135
136 void  update_assistant (struct import_assistant *ia);
137
138 bool init_file (struct import_assistant *ia, GtkWindow *parent_window);
139 void destroy_file (struct import_assistant *ia);
140
141 void prepare_sheet_spec_page (struct import_assistant *ia);
142 void reset_sheet_spec_page (struct import_assistant *);
143 void post_sheet_spec_page (struct import_assistant *ia);
144
145 void prepare_first_line_page (struct import_assistant *ia);
146 void reset_first_line_page (struct import_assistant *);
147
148 void reset_intro_page (struct import_assistant *ia);
149
150 void prepare_separators_page (struct import_assistant *ia);
151 void reset_separators_page (struct import_assistant *);
152 void destroy_separators_page (struct import_assistant *ia);
153
154 void prepare_formats_page (struct import_assistant *ia);
155 void reset_formats_page (struct import_assistant *);
156 void destroy_formats_page (struct import_assistant *ia);
157
158 struct import_assistant * init_assistant (GtkWindow *);
159 void destroy_assistant (struct import_assistant *);
160
161
162 #endif