Gnumeric reader cope with multiple passes, and empty cell elements
[pspp] / src / data / gnumeric-reader.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2007, 2009, 2010, 2011, 2012, 2013  Free Software Foundation, Inc.
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 #include <config.h>
18
19 #include "libpspp/message.h"
20 #include "libpspp/misc.h"
21
22 #include "gl/minmax.h"
23 #include "gl/c-strtod.h"
24
25 #include "gettext.h"
26 #define _(msgid) gettext (msgid)
27 #define N_(msgid) (msgid)
28
29 #include "spreadsheet-reader.h"
30
31 #include "c-xvasprintf.h"
32
33 #if !GNM_SUPPORT
34
35 struct casereader *
36 gnumeric_open_reader (struct spreadsheet_read_info *gri, struct spreadsheet_read_options *opts, struct dictionary **dict)
37 {
38   msg (ME, _("Support for %s files was not compiled into this installation of PSPP"), "Gnumeric");
39
40   return NULL;
41 }
42
43 #else
44
45 #include "data/gnumeric-reader.h"
46
47 #include <assert.h>
48 #include <stdbool.h>
49 #include <errno.h>
50 #include <libxml/xmlreader.h>
51 #include <zlib.h>
52
53 #include "data/case.h"
54 #include "data/casereader-provider.h"
55 #include "data/dictionary.h"
56 #include "data/identifier.h"
57 #include "data/value.h"
58 #include "data/variable.h"
59 #include "libpspp/i18n.h"
60 #include "libpspp/str.h"
61
62 #include "gl/xalloc.h"
63
64 static void gnm_file_casereader_destroy (struct casereader *, void *);
65
66 static struct ccase *gnm_file_casereader_read (struct casereader *, void *);
67
68 static const struct casereader_class gnm_file_casereader_class =
69   {
70     gnm_file_casereader_read,
71     gnm_file_casereader_destroy,
72     NULL,
73     NULL,
74   };
75
76 enum reader_state
77   {
78     STATE_PRE_INIT = 0,        /* Initial state */
79     STATE_SHEET_COUNT,      /* Found the sheet index */
80     STATE_INIT ,           /* Other Initial state */
81     STATE_SHEET_START,     /* Found the start of a sheet */
82     STATE_SHEET_NAME,      /* Found the sheet name */
83     STATE_MAXROW,
84     STATE_MAXCOL,
85     STATE_SHEET_FOUND,     /* Found the sheet that we actually want */
86     STATE_CELLS_START,     /* Found the start of the cell array */
87     STATE_CELL             /* Found a cell */
88   };
89
90 struct sheet_detail
91 {
92   xmlChar *name;
93
94   int start_col;
95   int stop_col;
96   int start_row;
97   int stop_row;
98
99   int maxcol;
100   int maxrow;
101 };
102
103
104 struct gnumeric_reader
105 {
106   struct spreadsheet spreadsheet;
107
108   /* The libxml reader for this instance */
109   xmlTextReaderPtr xtr;
110
111   /* An internal state variable */
112   enum reader_state state;
113
114   int row;
115   int col;
116   int min_col;
117   int node_type;
118   int current_sheet;
119
120   int start_col;
121   int stop_col;
122   int start_row;
123   int stop_row;
124   
125   struct sheet_detail *sheets;
126
127   const xmlChar *target_sheet;
128   int target_sheet_index;
129
130   struct caseproto *proto;
131   struct dictionary *dict;
132   struct ccase *first_case;
133   bool used_first_case;
134 };
135
136
137 const char *
138 gnumeric_get_sheet_name (struct spreadsheet *s, int n)
139 {
140   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
141   assert (n < s->n_sheets);
142
143   return gr->sheets[n].name;
144 }
145
146
147 static void process_node (struct gnumeric_reader *r);
148
149
150 char *
151 gnumeric_get_sheet_range (struct spreadsheet *s, int n)
152 {
153   int ret;
154   struct gnumeric_reader *gr = (struct gnumeric_reader *) s;
155   
156   assert (n < s->n_sheets);
157
158   while ( 
159          (gr->sheets[n].stop_col == -1)
160          && 
161          (1 == (ret = xmlTextReaderRead (gr->xtr)))
162           )
163     {
164       process_node (gr);
165     }
166
167   return create_cell_ref (
168                           gr->sheets[n].start_col,
169                           gr->sheets[n].start_row,
170                           gr->sheets[n].stop_col,
171                           gr->sheets[n].stop_row);
172 }
173
174
175 static void
176 gnm_file_casereader_destroy (struct casereader *reader UNUSED, void *r_)
177 {
178   int i;
179   struct gnumeric_reader *r = r_;
180   if ( r == NULL)
181         return ;
182
183   if ( r->xtr)
184     xmlFreeTextReader (r->xtr);
185   r->xtr = NULL;
186
187   if ( ! r->used_first_case )
188     case_unref (r->first_case);
189
190   caseproto_unref (r->proto);
191
192 #if 0
193   for (i = 0; i < r->spreadsheet.n_sheets; ++i)
194     {
195       xmlFree (r->sheets[i].name);
196     }
197     
198   free (r->sheets);
199
200
201   free (r);
202 #endif
203 }
204
205 static void
206 process_node (struct gnumeric_reader *r)
207 {
208   xmlChar *name = xmlTextReaderName (r->xtr);
209   if (name == NULL)
210     name = xmlStrdup (_xml ("--"));
211
212
213   r->node_type = xmlTextReaderNodeType (r->xtr);
214
215   switch ( r->state)
216     {
217     case STATE_PRE_INIT:
218       r->current_sheet = -1;
219       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
220           XML_READER_TYPE_ELEMENT  == r->node_type)
221         {
222           r->state = STATE_SHEET_COUNT;
223         }
224       break;
225
226     case STATE_SHEET_COUNT:
227       if (0 == xmlStrcasecmp (name, _xml("gnm:SheetName")) &&
228           XML_READER_TYPE_ELEMENT  == r->node_type)
229         {
230           ++r->current_sheet;
231           if (r->current_sheet + 1 > r->spreadsheet.n_sheets)
232             {
233               struct sheet_detail *sd ;
234               r->sheets = xrealloc (r->sheets, (r->current_sheet + 1) * sizeof *r->sheets);
235               sd = &r->sheets[r->current_sheet];
236               sd->start_col = sd->stop_col = sd->start_row = sd->stop_row = -1;
237               r->spreadsheet.n_sheets = r->current_sheet + 1;
238             }
239         }
240       else if (0 == xmlStrcasecmp (name, _xml("gnm:SheetNameIndex")) &&
241           XML_READER_TYPE_END_ELEMENT  == r->node_type)
242         {
243           r->state = STATE_INIT;
244           r->current_sheet = -1;
245         }
246       else if (XML_READER_TYPE_TEXT == r->node_type)
247         {
248           r->sheets [r->spreadsheet.n_sheets - 1].name = xmlTextReaderValue (r->xtr);
249         }
250       break;
251
252     case STATE_INIT:
253       if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet")) &&
254           XML_READER_TYPE_ELEMENT  == r->node_type)
255         {
256           ++r->current_sheet;
257           r->state = STATE_SHEET_START;
258         }
259       break;
260     case STATE_SHEET_START:
261       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
262           XML_READER_TYPE_ELEMENT  == r->node_type)
263         {
264           r->state = STATE_SHEET_NAME;
265         }
266       break;
267     case STATE_SHEET_NAME:
268       if (0 == xmlStrcasecmp (name, _xml("gnm:Name"))  &&
269           XML_READER_TYPE_END_ELEMENT  == r->node_type)
270         {
271           r->state = STATE_INIT;
272         }
273       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
274           XML_READER_TYPE_END_ELEMENT  == r->node_type)
275         {
276           r->state = STATE_INIT;
277         }
278       else if (XML_READER_TYPE_TEXT == r->node_type)
279         {
280           if ( r->target_sheet != NULL)
281             {
282               xmlChar *value = xmlTextReaderValue (r->xtr);
283               if ( 0 == xmlStrcmp (value, r->target_sheet))
284                 r->state = STATE_SHEET_FOUND;
285               free (value);
286             }
287           else if (r->target_sheet_index == r->current_sheet + 1)
288             {
289               r->state = STATE_SHEET_FOUND;
290             }
291           else if (r->target_sheet_index == -1)
292             {
293               r->state = STATE_SHEET_FOUND;
294             }
295         }
296       break;
297     case STATE_SHEET_FOUND:
298       if (0 == xmlStrcasecmp (name, _xml("gnm:Cells"))  &&
299           XML_READER_TYPE_ELEMENT  == r->node_type)
300         {
301           r->min_col = INT_MAX;
302           if (! xmlTextReaderIsEmptyElement (r->xtr))
303             r->state = STATE_CELLS_START;
304         }
305       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
306           XML_READER_TYPE_ELEMENT  == r->node_type)
307         {
308           r->state = STATE_MAXROW;
309         }
310       else if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol"))  &&
311           XML_READER_TYPE_ELEMENT  == r->node_type)
312         {
313           r->state = STATE_MAXCOL;
314         }
315       else if (0 == xmlStrcasecmp (name, _xml("gnm:Sheet"))  &&
316           XML_READER_TYPE_END_ELEMENT  == r->node_type)
317         {
318           r->state = STATE_INIT;
319         }
320       break;
321     case STATE_MAXROW:
322       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxRow"))  &&
323           XML_READER_TYPE_END_ELEMENT  == r->node_type)
324         {
325           r->state = STATE_SHEET_FOUND;
326         }
327       else if (r->node_type == XML_READER_TYPE_TEXT)
328         {
329           xmlChar *value = xmlTextReaderValue (r->xtr);
330           r->sheets[r->current_sheet].maxrow = _xmlchar_to_int (value);
331           xmlFree (value);
332         }
333       break;
334     case STATE_MAXCOL:
335       if (0 == xmlStrcasecmp (name, _xml("gnm:MaxCol"))  &&
336           XML_READER_TYPE_END_ELEMENT  == r->node_type)
337         {
338           r->state = STATE_SHEET_FOUND;
339         }
340       else if (r->node_type == XML_READER_TYPE_TEXT)
341         {
342           xmlChar *value = xmlTextReaderValue (r->xtr);
343           r->sheets[r->current_sheet].maxcol = _xmlchar_to_int (value);
344           xmlFree (value);
345         }
346       break;
347     case STATE_CELLS_START:
348       if (0 == xmlStrcasecmp (name, _xml ("gnm:Cell"))  &&
349           XML_READER_TYPE_ELEMENT  == r->node_type)
350         {
351           xmlChar *attr = NULL;
352
353           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Col"));
354           r->col =  _xmlchar_to_int (attr);
355           free (attr);
356
357           if (r->col < r->min_col)
358             r->min_col = r->col;
359
360           attr = xmlTextReaderGetAttribute (r->xtr, _xml ("Row"));
361           r->row = _xmlchar_to_int (attr);
362           free (attr);
363
364           if (r->sheets[r->current_sheet].start_row == -1)
365             {
366               r->sheets[r->current_sheet].start_row = r->row;
367             }
368
369           if (r->sheets[r->current_sheet].start_col == -1)
370             {
371               r->sheets[r->current_sheet].start_col = r->col;
372             }
373           if (! xmlTextReaderIsEmptyElement (r->xtr))
374             r->state = STATE_CELL;
375         }
376       else if ( (0 == xmlStrcasecmp (name, _xml("gnm:Cells")))  &&  (XML_READER_TYPE_END_ELEMENT  == r->node_type) )
377         {
378           r->sheets[r->current_sheet].stop_col = r->col;
379           r->sheets[r->current_sheet].stop_row = r->row;
380           r->state = STATE_SHEET_NAME;
381         }
382       break;
383     case STATE_CELL:
384       if (0 == xmlStrcasecmp (name, _xml("gnm:Cell"))  && XML_READER_TYPE_END_ELEMENT  == r->node_type)
385         {
386           r->state = STATE_CELLS_START;
387         }
388       break;
389     default:
390       break;
391     };
392
393   xmlFree (name);
394 }
395
396
397 /*
398    Sets the VAR of case C, to the value corresponding to the xml string XV
399  */
400 static void
401 convert_xml_string_to_value (struct ccase *c, const struct variable *var,
402                              const xmlChar *xv)
403 {
404   union value *v = case_data_rw (c, var);
405
406   if (xv == NULL)
407     value_set_missing (v, var_get_width (var));
408   else if ( var_is_alpha (var))
409     value_copy_str_rpad (v, var_get_width (var), xv, ' ');
410   else
411     {
412       const char *text = CHAR_CAST (const char *, xv);
413       char *endptr;
414
415       errno = 0;
416       v->f = c_strtod (text, &endptr);
417       if ( errno != 0 || endptr == text)
418         v->f = SYSMIS;
419     }
420 }
421
422 struct var_spec
423 {
424   char *name;
425   int width;
426   xmlChar *first_value;
427 };
428
429
430 void 
431 gnumeric_destroy (struct spreadsheet *s)
432 {
433   struct gnumeric_reader *r = (struct gnumeric *) s;
434   gnm_file_casereader_destroy (NULL, s);
435 }
436
437
438 static struct gnumeric_reader *
439 gnumeric_reopen (struct gnumeric_reader *r, const char *filename)
440 {  
441   int ret;
442
443   xmlTextReaderPtr xtr;
444   gzFile gz;
445
446   assert (r == NULL || filename == NULL);
447
448   if (r && r->xtr)
449     xmlFreeTextReader (r->xtr);
450
451   if (filename)
452     gz = gzopen (filename, "r");
453   else
454     gz = gzopen ( r->spreadsheet.file_name, "r");
455
456   if (NULL == gz)
457     return NULL;
458
459   xtr = xmlReaderForIO ((xmlInputReadCallback) gzread,
460                            (xmlInputCloseCallback) gzclose, gz,
461                            NULL, NULL, 0);
462
463   if (xtr == NULL)
464     {
465       gzclose (gz);
466       return NULL;
467     }
468
469   if (r == NULL)
470     {
471       r = xzalloc (sizeof *r);
472       r->spreadsheet.n_sheets = -1;
473       r->spreadsheet.file_name = filename;
474     }
475
476   r->target_sheet = NULL;
477   r->target_sheet_index = -1;
478
479   r->row = r->col = -1;
480   r->state = STATE_PRE_INIT;
481   r->xtr = xtr;
482
483   /* Advance to the start of the workbook.
484      This gives us some confidence that we are actually dealing with a gnumeric
485      spreadsheet.
486    */
487   while ( (r->state != STATE_INIT )
488           && 1 == (ret = xmlTextReaderRead (r->xtr)))
489     {
490       process_node (r);
491     }
492
493   r->spreadsheet.type = SPREADSHEET_GNUMERIC;
494
495   return r;
496 }
497
498
499 struct spreadsheet *
500 gnumeric_probe (const char *filename)
501 {
502   struct gnumeric_reader *r = gnumeric_reopen (NULL, filename);
503
504   return &r->spreadsheet;
505 }
506
507
508 struct casereader *
509 gnumeric_make_reader (struct spreadsheet *spreadsheet,
510                       const struct spreadsheet_read_info *gri, 
511                       struct spreadsheet_read_options *opts)
512 {
513   struct gnumeric_reader *r = NULL;
514   unsigned long int vstart = 0;
515   int ret;
516   casenumber n_cases = CASENUMBER_MAX;
517   int i;
518   struct var_spec *var_spec = NULL;
519   int n_var_specs = 0;
520
521   r = (struct gnumeric_reader *) (spreadsheet);
522
523   if (r->row != -1)
524     r = gnumeric_reopen (r, NULL);
525
526   if ( opts->cell_range )
527     {
528       if ( ! convert_cell_ref (opts->cell_range,
529                                &r->start_col, &r->start_row,
530                                &r->stop_col, &r->stop_row))
531         {
532           msg (SE, _("Invalid cell range `%s'"),
533                opts->cell_range);
534           goto error;
535         }
536     }
537   else
538     {
539       r->start_col = -1;
540       r->start_row = 0;
541       r->stop_col = -1;
542       r->stop_row = -1;
543     }
544
545   r->target_sheet = BAD_CAST opts->sheet_name;
546   r->target_sheet_index = opts->sheet_index;
547   r->row = r->col = -1;
548   r->current_sheet = -1;
549
550   /* Advance to the start of the cells for the target sheet */
551   while ( (r->state != STATE_CELL || r->row < r->start_row )
552           && 1 == (ret = xmlTextReaderRead (r->xtr)))
553     {
554       xmlChar *value ;
555       process_node (r);
556       value = xmlTextReaderValue (r->xtr);
557
558       if ( r->state == STATE_MAXROW  && r->node_type == XML_READER_TYPE_TEXT)
559         {
560           n_cases = 1 + _xmlchar_to_int (value) ;
561         }
562       free (value);
563     }
564
565   /* If a range has been given, then  use that to calculate the number
566      of cases */
567   if ( opts->cell_range)
568     {
569       n_cases = MIN (n_cases, r->stop_row - r->start_row + 1);
570     }
571
572   if ( gri->read_names )
573     {
574       r->start_row++;
575       n_cases --;
576     }
577
578   /* Read in the first row of cells,
579      including the headers if read_names was set */
580   while (
581          (( r->state == STATE_CELLS_START && r->row <= r->start_row) || r->state == STATE_CELL )
582          && (ret = xmlTextReaderRead (r->xtr))
583          )
584     {
585       int idx;
586       process_node (r);
587
588       if ( r->row > r->start_row ) break;
589
590       if ( r->col < r->start_col ||
591            (r->stop_col != -1 && r->col > r->stop_col))
592         continue;
593
594       idx = r->col - r->start_col;
595
596       if ( idx  >= n_var_specs )
597         {
598           int i;
599           var_spec = xrealloc (var_spec, sizeof (*var_spec) * (idx + 1));
600           for (i = n_var_specs; i <= idx; ++i)
601           {
602             var_spec [i].name = NULL;
603             var_spec [i].width = -1;
604             var_spec [i].first_value = NULL;
605           }
606           n_var_specs =  idx + 1 ;
607         }
608
609       if ( r->node_type == XML_READER_TYPE_TEXT )
610         {
611           xmlChar *value = xmlTextReaderValue (r->xtr);
612           const char *text  = CHAR_CAST (const char *, value);
613
614           if ( r->row < r->start_row)
615             {
616               if ( gri->read_names )
617                 {
618                   var_spec [idx].name = xstrdup (text);
619                 }
620             }
621           else
622             {
623               var_spec [idx].first_value = xmlStrdup (value);
624
625               if (-1 ==  var_spec [idx].width )
626                 var_spec [idx].width = (gri->asw == -1) ?
627                   ROUND_UP (strlen(text), SPREADSHEET_DEFAULT_WIDTH) : gri->asw;
628             }
629
630           free (value);
631         }
632       else if ( r->node_type == XML_READER_TYPE_ELEMENT
633                 && r->state == STATE_CELL)
634         {
635           if ( r->row == r->start_row )
636             {
637               xmlChar *attr =
638                 xmlTextReaderGetAttribute (r->xtr, _xml ("ValueType"));
639
640               if ( NULL == attr || 60 !=  _xmlchar_to_int (attr))
641                 var_spec [idx].width = 0;
642
643               free (attr);
644             }
645         }
646     }
647
648   {
649     const xmlChar *enc = xmlTextReaderConstEncoding (r->xtr);
650     if ( enc == NULL)
651       goto error;
652     /* Create the dictionary and populate it */
653     spreadsheet->dict = r->dict = dict_create (CHAR_CAST (const char *, enc));
654   }
655
656   for (i = 0 ; i < n_var_specs ; ++i )
657     {
658       char *name;
659
660       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
661         continue;
662
663       /* Probably no data exists for this variable, so allocate a
664          default width */
665       if ( var_spec[i].width == -1 )
666         var_spec[i].width = SPREADSHEET_DEFAULT_WIDTH;
667
668       name = dict_make_unique_var_name (r->dict, var_spec[i].name, &vstart);
669       dict_create_var (r->dict, name, var_spec[i].width);
670       free (name);
671     }
672
673   /* Create the first case, and cache it */
674   r->used_first_case = false;
675
676   if ( n_var_specs ==  0 )
677     {
678       msg (MW, _("Selected sheet or range of spreadsheet `%s' is empty."),
679            spreadsheet->file_name);
680       goto error;
681     }
682
683   r->proto = caseproto_ref (dict_get_proto (r->dict));
684   r->first_case = case_create (r->proto);
685   case_set_missing (r->first_case);
686
687   int x = 0;
688   for ( i = 0 ; i < n_var_specs ; ++i )
689     {
690       if ( (var_spec[i].name == NULL) && (var_spec[i].first_value == NULL))
691         continue;
692
693       const struct variable *var = dict_get_var (r->dict, x++);
694
695       convert_xml_string_to_value (r->first_case, var,
696                                    var_spec[i].first_value);
697     }
698
699   for ( i = 0 ; i < n_var_specs ; ++i )
700     {
701       free (var_spec[i].first_value);
702       free (var_spec[i].name);
703     }
704
705   free (var_spec);
706   
707   
708   if (opts->cell_range == NULL)
709     {
710       opts->cell_range = c_xasprintf ("%c%d:%c%ld", 
711                                        r->start_col + 'A',
712                                        r->start_row,
713                                        r->stop_col + 'A' + caseproto_get_n_widths (r->proto),
714                                        r->start_row + n_cases);
715     }
716   
717   return casereader_create_sequential
718     (NULL,
719      r->proto,
720      n_cases,
721      &gnm_file_casereader_class, r);
722
723
724  error:
725   for ( i = 0 ; i < n_var_specs ; ++i )
726     {
727       free (var_spec[i].first_value);
728       free (var_spec[i].name);
729     }
730
731   free (var_spec);
732   dict_destroy (spreadsheet->dict);
733   spreadsheet->dict = NULL;
734
735   gnm_file_casereader_destroy (NULL, r);
736
737   return NULL;
738 };
739
740
741 /* Reads and returns one case from READER's file.  Returns a null
742    pointer on failure. */
743 static struct ccase *
744 gnm_file_casereader_read (struct casereader *reader UNUSED, void *r_)
745 {
746   struct ccase *c;
747   int ret = 0;
748
749   struct gnumeric_reader *r = r_;
750   int current_row = r->row;
751
752   if ( !r->used_first_case )
753     {
754       r->used_first_case = true;
755       return r->first_case;
756     }
757
758   c = case_create (r->proto);
759   case_set_missing (c);
760
761   if (r->start_col == -1)
762     r->start_col = r->min_col;
763
764   while ((r->state == STATE_CELL || r->state == STATE_CELLS_START )
765          && r->row == current_row && (ret = xmlTextReaderRead (r->xtr)))
766     {
767       process_node (r);
768
769       if ( r->col < r->start_col || (r->stop_col != -1 &&
770                                      r->col > r->stop_col))
771         continue;
772
773       if ( r->col - r->start_col >= caseproto_get_n_widths (r->proto))
774         continue;
775
776       if ( r->stop_row != -1 && r->row > r->stop_row)
777         break;
778
779       if ( r->node_type == XML_READER_TYPE_TEXT )
780         {
781           xmlChar *value = xmlTextReaderValue (r->xtr);
782
783           const int idx = r->col - r->start_col;
784
785           const struct variable *var = dict_get_var (r->dict, idx);
786
787           convert_xml_string_to_value (c, var, value);
788
789           free (value);
790         }
791
792     }
793
794   if (ret == 1)
795     return c;
796   else
797     {
798       case_unref (c);
799       return NULL;
800     }
801 }
802
803
804 #endif /* GNM_SUPPORT */