1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
|
/*
* $Id$
*
* ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version. The Blender
* Foundation also sells licenses for use in proprietary software under
* the Blender License. See http://www.blender.org/BL/ for information
* about this.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* This is a new part of Blender.
*
* Contributor(s): Willian P. Germano, Michael Reimpell
*
* ***** END GPL/BL DUAL LICENSE BLOCK *****
*/
/*
*This is the main file responsible for having bpython scripts accessible
* from Blender menus. To know more, please start with its header file.
*/
#include "BPY_menus.h"
#include <Python.h>
#ifndef WIN32
#include <dirent.h>
#else
#include "BLI_winstuff.h"
#endif
#include "BKE_global.h"
#include "BKE_utildefines.h"
#include "BLI_blenlib.h"
#include "MEM_guardedalloc.h"
#include "DNA_userdef_types.h" /* for U.pythondir */
#include "api2_2x/EXPP_interface.h" /* for bpy_gethome() */
#define BPYMENU_DATAFILE "Bpymenus"
#define MAX_DIR_DEPTH 4 /* max depth for traversing scripts dirs */
#define MAX_DIR_NUMBER 30 /* max number of dirs in scripts dirs trees */
static int DEBUG;
static int Dir_Depth;
static int Dirs_Number;
/* BPyMenuTable holds all registered pymenus, as linked lists for each menu
* where they can appear (see PYMENUHOOKS enum in BPY_menus.h).
*/
BPyMenu *BPyMenuTable[PYMENU_TOTAL];
static int bpymenu_group_atoi( char *str )
{
if( !strcmp( str, "Export" ) )
return PYMENU_EXPORT;
else if( !strcmp( str, "Import" ) )
return PYMENU_IMPORT;
else if( !strcmp( str, "Help" ) )
return PYMENU_HELP;
else if( !strcmp( str, "HelpWebsites" ) )
return PYMENU_HELPWEBSITES;
else if( !strcmp( str, "HelpSystem" ) )
return PYMENU_HELPSYSTEM;
else if( !strcmp( str, "Render" ) )
return PYMENU_RENDER;
else if( !strcmp( str, "System" ) )
return PYMENU_SYSTEM;
else if( !strcmp( str, "Object" ) )
return PYMENU_OBJECT;
else if( !strcmp( str, "Mesh" ) )
return PYMENU_MESH;
else if( !strncmp( str, "Theme", 5 ) )
return PYMENU_THEMES;
else if( !strcmp( str, "Add" ) )
return PYMENU_ADD;
else if( !strcmp( str, "Wizards" ) )
return PYMENU_WIZARDS;
else if( !strcmp( str, "Animation" ) )
return PYMENU_ANIMATION;
else if( !strcmp( str, "Materials" ) )
return PYMENU_MATERIALS;
else if( !strcmp( str, "UV" ) )
return PYMENU_UV;
else if( !strcmp( str, "Image" ) )
return PYMENU_IMAGE;
else if( !strcmp( str, "FaceSelect" ) )
return PYMENU_FACESELECT;
else if( !strcmp( str, "WeightPaint" ) )
return PYMENU_WEIGHTPAINT;
else if( !strcmp( str, "VertexPaint" ) )
return PYMENU_VERTEXPAINT;
else if( !strcmp( str, "UVCalculation" ) )
return PYMENU_UVCALCULATION;
else if( !strcmp( str, "Armature" ) )
return PYMENU_ARMATURE;
else if( !strcmp( str, "ScriptTemplate" ) )
return PYMENU_SCRIPTTEMPLATE;
else if( !strcmp( str, "MeshFaceKey" ) )
return PYMENU_MESHFACEKEY;
else if( !strcmp( str, "AddMesh" ) )
return PYMENU_ADDMESH;
/* "Misc" or an inexistent group name: use misc */
else
return PYMENU_MISC;
}
char *BPyMenu_group_itoa( short menugroup )
{
switch ( menugroup ) {
case PYMENU_EXPORT:
return "Export";
break;
case PYMENU_IMPORT:
return "Import";
break;
case PYMENU_ADD:
return "Add";
break;
case PYMENU_HELP:
return "Help";
break;
case PYMENU_HELPWEBSITES:
return "HelpWebsites";
break;
case PYMENU_HELPSYSTEM:
return "HelpSystem";
break;
case PYMENU_RENDER:
return "Render";
break;
case PYMENU_SYSTEM:
return "System";
break;
case PYMENU_OBJECT:
return "Object";
break;
case PYMENU_MESH:
return "Mesh";
break;
case PYMENU_THEMES:
return "Themes";
break;
case PYMENU_WIZARDS:
return "Wizards";
break;
case PYMENU_ANIMATION:
return "Animation";
break;
case PYMENU_MATERIALS:
return "Materials";
break;
case PYMENU_UV:
return "UV";
break;
case PYMENU_IMAGE:
return "Image";
break;
case PYMENU_FACESELECT:
return "FaceSelect";
break;
case PYMENU_WEIGHTPAINT:
return "WeightPaint";
break;
case PYMENU_VERTEXPAINT:
return "VertexPaint";
break;
case PYMENU_UVCALCULATION:
return "UVCalculation";
break;
case PYMENU_ARMATURE:
return "Armature";
break;
case PYMENU_SCRIPTTEMPLATE:
return "ScriptTemplate";
break;
case PYMENU_MESHFACEKEY:
return "MeshFaceKey";
break;
case PYMENU_ADDMESH:
return "AddMesh";
break;
case PYMENU_MISC:
return "Misc";
break;
}
return NULL;
}
/* BPyMenu_CreatePupmenuStr:
* build and return a meaninful string to be used by pupmenu(). The
* string is made of a bpymenu name as title and its submenus as possible
* choices for the user.
*/
char *BPyMenu_CreatePupmenuStr( BPyMenu * pym, short menugroup )
{
BPySubMenu *pysm = pym->submenus;
char str[1024], str2[100];
int i = 0, rlen;
if( !pym || !pysm )
return NULL;
str[0] = '\0';
PyOS_snprintf( str2, sizeof( str2 ), "%s: %s%%t",
BPyMenu_group_itoa( menugroup ), pym->name );
strcat( str, str2 );
while( pysm ) {
PyOS_snprintf( str2, sizeof( str2 ), "|%s%%x%d", pysm->name,
i );
rlen = sizeof( str ) - strlen( str );
strncat( str, str2, rlen );
i++;
pysm = pysm->next;
}
return BLI_strdup( str );
}
static void bpymenu_RemoveAllSubEntries( BPySubMenu * smenu )
{
BPySubMenu *tmp;
while( smenu ) {
tmp = smenu->next;
if( smenu->name )
MEM_freeN( smenu->name );
if( smenu->arg )
MEM_freeN( smenu->arg );
MEM_freeN( smenu );
smenu = tmp;
}
return;
}
void BPyMenu_RemoveAllEntries( void )
{
BPyMenu *tmp, *pymenu;
int i;
for( i = 0; i < PYMENU_TOTAL; i++ ) {
pymenu = BPyMenuTable[i];
while( pymenu ) {
tmp = pymenu->next;
if( pymenu->name )
MEM_freeN( pymenu->name );
if( pymenu->filename )
MEM_freeN( pymenu->filename );
if( pymenu->tooltip )
MEM_freeN( pymenu->tooltip );
if( pymenu->submenus )
bpymenu_RemoveAllSubEntries( pymenu->
submenus );
MEM_freeN( pymenu );
pymenu = tmp;
}
BPyMenuTable[i] = NULL;
}
Dirs_Number = 0;
Dir_Depth = 0;
return;
}
static BPyMenu *bpymenu_FindEntry( short group, char *name )
{
BPyMenu *pymenu;
if( ( group < 0 ) || ( group >= PYMENU_TOTAL ) )
return NULL;
pymenu = BPyMenuTable[group];
while( pymenu ) {
if( !strcmp( pymenu->name, name ) )
return pymenu;
pymenu = pymenu->next;
}
return NULL;
}
/* BPyMenu_GetEntry:
* given a group and a position, return the entry in that position from
* that group.
*/
BPyMenu *BPyMenu_GetEntry( short group, short pos )
{
BPyMenu *pym = NULL;
if( ( group < 0 ) || ( group >= PYMENU_TOTAL ) )
return NULL;
pym = BPyMenuTable[group];
while( pos-- ) {
if( pym )
pym = pym->next;
else
break;
}
return pym; /* found entry or NULL */
}
static void bpymenu_set_tooltip( BPyMenu * pymenu, char *tip )
{
if( !pymenu )
return;
if( pymenu->tooltip )
MEM_freeN( pymenu->tooltip );
pymenu->tooltip = BLI_strdup( tip );
return;
}
/* bpymenu_AddEntry:
* try to find an existing pymenu entry with the given type and name;
* if found, update it with new info, otherwise create a new one and fill it.
*/
static BPyMenu *bpymenu_AddEntry( short group, short version, char *name,
char *fname, int is_userdir, char *tooltip )
{
BPyMenu *menu, *next = NULL, **iter;
int nameclash = 0;
if( ( group < 0 ) || ( group >= PYMENU_TOTAL ) )
return NULL;
if( !name || !fname )
return NULL;
menu = bpymenu_FindEntry( group, name ); /* already exists? */
/* if a menu with this name already exists in the same group:
* - if one script is in the default dir and the other in U.pythondir,
* accept and let the new one override the other.
* - otherwise, report the error and return NULL. */
if( menu ) {
if( menu->dir < is_userdir ) { /* new one is in U.pythondir */
nameclash = 1;
if( menu->name )
MEM_freeN( menu->name );
if( menu->filename )
MEM_freeN( menu->filename );
if( menu->tooltip )
MEM_freeN( menu->tooltip );
if( menu->submenus )
bpymenu_RemoveAllSubEntries( menu->submenus );
next = menu->next;
} else { /* they are in the same dir */
if (DEBUG) {
fprintf(stderr, "\n\
Warning: script %s's menu name is already in use.\n\
Edit the script and change its \n\
Name: '%s'\n\
field, please.\n\
Note: if you really want to have two scripts for the same menu with\n\
the same name, keep one in the default dir and the other in\n\
the user defined dir (only the later will be registered).\n", fname, name);
}
return NULL;
}
} else
menu = MEM_mallocN( sizeof( BPyMenu ), "pymenu" );
if( !menu )
return NULL;
menu->name = BLI_strdup( name );
menu->version = version;
menu->filename = BLI_strdup( fname );
menu->tooltip = NULL;
if( tooltip )
menu->tooltip = BLI_strdup( tooltip );
menu->dir = is_userdir;
menu->submenus = NULL;
menu->next = next; /* non-NULL if menu already existed */
if( nameclash )
return menu; /* no need to place it, it's already at the list */
else { /* insert the new entry in its correct position at the table */
BPyMenu *prev = NULL;
char *s = NULL;
iter = &BPyMenuTable[group];
while( *iter ) {
s = ( *iter )->name;
if( s )
if( strcmp( menu->name, s ) < 0 )
break; /* sort by names */
prev = *iter;
iter = &( ( *iter )->next );
}
if( *iter ) { /* prepend */
menu->next = *iter;
if( prev )
prev->next = menu;
else
BPyMenuTable[group] = menu; /* is first entry */
} else
*iter = menu; /* append */
}
return menu;
}
/* bpymenu_AddSubEntry:
* add a submenu to an existing python menu.
*/
static int bpymenu_AddSubEntry( BPyMenu * mentry, char *name, char *arg )
{
BPySubMenu *smenu, **iter;
smenu = MEM_mallocN( sizeof( BPySubMenu ), "pysubmenu" );
if( !smenu )
return -1;
smenu->name = BLI_strdup( name );
smenu->arg = BLI_strdup( arg );
smenu->next = NULL;
if( !smenu->name || !smenu->arg )
return -1;
iter = &( mentry->submenus );
while( *iter )
iter = &( ( *iter )->next );
*iter = smenu;
return 0;
}
/* bpymenu_CreateFromFile:
* parse the bpymenus data file where Python menu data is stored;
* based on this data, create and fill the pymenu structs.
*/
static int bpymenu_CreateFromFile( void )
{
FILE *fp;
char line[255], w1[255], w2[255], tooltip[255], *tip;
char upythondir[FILE_MAXDIR];
char *homedir = NULL;
int parsing, version, is_userdir;
short group;
BPyMenu *pymenu = NULL;
/* init global bpymenu table (it is a list of pointers to struct BPyMenus
* for each available cathegory: import, export, etc.) */
for( group = 0; group < PYMENU_TOTAL; group++ )
BPyMenuTable[group] = NULL;
/* let's try to open the file with bpymenu data */
homedir = bpy_gethome(0);
if (!homedir) {
if( DEBUG )
fprintf(stderr,
"BPyMenus error: couldn't open config file Bpymenus: no home dir.\n");
return -1;
}
BLI_make_file_string( "/", line, homedir, BPYMENU_DATAFILE );
fp = fopen( line, "rb" );
if( !fp ) {
if( DEBUG )
fprintf(stderr, "BPyMenus error: couldn't open config file %s.\n", line );
return -1;
}
fgets( line, 255, fp ); /* header */
/* check if the U.pythondir we saved at the file is different from the
* current one. If so, return to force updating from dirs */
w1[0] = '\0';
fscanf( fp, "# User defined scripts dir: %[^\n]\n", w1 );
BLI_strncpy(upythondir, U.pythondir, FILE_MAXDIR);
BLI_convertstringcode(upythondir, G.sce, 0);
if( strcmp( w1, upythondir ) != 0 )
return -1;
w1[0] = '\0';
while( fgets( line, 255, fp ) ) { /* parsing file lines */
switch ( line[0] ) { /* check first char */
case '#': /* comment */
continue;
break;
case '\n':
continue;
break;
default:
parsing = sscanf( line, "%s {\n", w1 ); /* menu group */
break;
}
if( parsing == 1 ) { /* got menu group string */
group = (short)bpymenu_group_atoi( w1 );
if( group < 0 && DEBUG ) { /* invalid type */
fprintf(stderr,
"BPyMenus error parsing config file: wrong group: %s,\n\
will use 'Misc'.\n", w1 );
}
} else
continue;
for(;;) {
tip = NULL; /* optional tooltip */
fgets( line, 255, fp );
if( line[0] == '}' )
break;
else if( line[0] == '\n' )
continue;
else if( line[0] == '\'' ) { /* menu entry */
parsing =
sscanf( line,
"'%[^']' %d %s %d '%[^']'\n",
w1, &version, w2, &is_userdir,
tooltip );
if( parsing <= 0 ) { /* invalid line, get rid of it */
fgets( line, 255, fp );
} else if( parsing == 5 )
tip = tooltip; /* has tooltip */
pymenu = bpymenu_AddEntry( group,
( short ) version,
w1, w2, is_userdir,
tip );
if( !pymenu ) {
puts( "BPyMenus error: couldn't create bpymenu entry.\n" );
fclose( fp );
return -1;
}
} else if( line[0] == '|' && line[1] == '_' ) { /* menu sub-entry */
if( !pymenu )
continue; /* no menu yet, skip this line */
sscanf( line, "|_%[^:]: %s\n", w1, w2 );
bpymenu_AddSubEntry( pymenu, w1, w2 );
}
}
}
fclose( fp );
return 0;
}
/* bpymenu_WriteDataFile:
* writes the registered scripts info to the user's home dir, for faster
* access when the scripts dir hasn't changed.
*/
static void bpymenu_WriteDataFile( void )
{
BPyMenu *pymenu;
BPySubMenu *smenu;
FILE *fp;
char fname[FILE_MAXDIR], *homedir;
int i;
homedir = bpy_gethome(0);
if (!homedir) {
if( DEBUG )
fprintf(stderr,
"BPyMenus error: couldn't write Bpymenus file: no home dir.\n\n");
return;
}
BLI_make_file_string( "/", fname, homedir, BPYMENU_DATAFILE );
fp = fopen( fname, "w" );
if( !fp ) {
if( DEBUG )
fprintf(stderr, "BPyMenus error: couldn't write %s file.\n\n",
fname );
return;
}
fprintf( fp,
"# Blender: registered menu entries for bpython scripts\n" );
if (U.pythondir[0] != '\0' &&
strcmp(U.pythondir, "/") != 0 && strcmp(U.pythondir, "//") != 0)
{
char upythondir[FILE_MAXDIR];
BLI_strncpy(upythondir, U.pythondir, FILE_MAXDIR);
BLI_convertstringcode(upythondir, G.sce, 0);
fprintf( fp, "# User defined scripts dir: %s\n", upythondir );
}
for( i = 0; i < PYMENU_TOTAL; i++ ) {
pymenu = BPyMenuTable[i];
if( !pymenu )
continue;
fprintf( fp, "\n%s {\n", BPyMenu_group_itoa( (short)i ) );
while( pymenu ) {
fprintf( fp, "'%s' %d %s %d", pymenu->name,
pymenu->version, pymenu->filename,
pymenu->dir );
if( pymenu->tooltip )
fprintf( fp, " '%s'\n", pymenu->tooltip );
else
fprintf( fp, "\n" );
smenu = pymenu->submenus;
while( smenu ) {
fprintf( fp, "|_%s: %s\n", smenu->name,
smenu->arg );
smenu = smenu->next;
}
pymenu = pymenu->next;
}
fprintf( fp, "}\n" );
}
fclose( fp );
return;
}
/* BPyMenu_PrintAllEntries:
* useful for debugging.
*/
void BPyMenu_PrintAllEntries( void )
{
BPyMenu *pymenu;
BPySubMenu *smenu;
int i;
printf( "# Blender: registered menu entries for bpython scripts\n" );
for( i = 0; i < PYMENU_TOTAL; i++ ) {
pymenu = BPyMenuTable[i];
printf( "\n%s {\n", BPyMenu_group_itoa( (short)i ) );
while( pymenu ) {
printf( "'%s' %d %s %d", pymenu->name, pymenu->version,
pymenu->filename, pymenu->dir );
if( pymenu->tooltip )
printf( " '%s'\n", pymenu->tooltip );
else
printf( "\n" );
smenu = pymenu->submenus;
while( smenu ) {
printf( "|_%s: %s\n", smenu->name,
smenu->arg );
smenu = smenu->next;
}
pymenu = pymenu->next;
}
printf( "}\n" );
}
}
/* bpymenu_ParseFile:
* recursively scans folders looking for scripts to register.
*
* This function scans the scripts directory looking for .py files with the
* right header and menu info, using that to fill the bpymenu structs.
* is_userdir defines if the script is in the default scripts dir or the
* user defined one (U.pythondir: is_userdir == 1).
* Speed is important.
*
* The first line of the script must be '#!BPY'.
* The header registration lines must appear between the first pair of
* '\"\"\"' and follow this order (the single-quotes are part of
* the format):
*
* # \"\"\"<br>
* # Name: 'script name for the menu'
* # Blender: <code>short int</code> (minimal Blender version)
* # Group: 'group name' (defines menu)
* # Submenu: 'submenu name' related_1word_arg
* # Tooltip: 'tooltip for the menu'
* # \"\"\"
*
* Notes:
*
* - Commenting out header lines with "#" is optional, but recommended.
* - There may be more than one submenu line, or none:
* submenus and the tooltip are optional;
* - The Blender version is the same number reported by
* Blender.Get('version') in BPython or G.version in C;
* - Line length must be less than 99.
*/
static int bpymenu_ParseFile(FILE *file, char *fname, int is_userdir)
{
char line[100];
char head[100];
char middle[100];
char tail[100];
int matches;
int parser_state;
char script_name[100];
int script_version = 1;
int script_group;
BPyMenu *scriptMenu = NULL;
if (file != NULL) {
parser_state = 1; /* state of parser, 0 to terminate */
while ((parser_state != 0) && (fgets(line, 100, file) != NULL)) {
switch (parser_state) {
case 1: /* !BPY */
if (strncmp(line, "#!BPY", 5) == 0) {
parser_state++;
} else {
parser_state = 0;
}
break;
case 2: /* \"\"\" */
if ((strstr(line, "\"\"\""))) {
parser_state++;
}
break;
case 3: /* Name: 'script name for the menu' */
matches = sscanf(line, "%[^']'%[^']'%c", head, script_name, tail);
if ((matches == 3) && (strstr(head, "Name:") != NULL)) {
parser_state++;
} else {
if (DEBUG)
fprintf(stderr, "BPyMenus error: Wrong 'Name' line: %s\n", fname);
parser_state = 0;
}
break;
case 4: /* Blender: <short int> */
matches = sscanf(line, "%[^1234567890]%i%c", head, &script_version,
tail);
if (matches == 3) {
parser_state++;
} else {
if (DEBUG)
fprintf(stderr,"BPyMenus error: Wrong 'Blender' line: %s\n",fname);
parser_state = 0;
}
break;
case 5: /* Group: 'group name' */
matches = sscanf(line, "%[^']'%[^']'%c", head, middle, tail);
if ((matches == 3) && (strstr(head, "Group:") != NULL)) {
script_group = bpymenu_group_atoi(middle);
if (script_group < 0) {
if (DEBUG)
fprintf(stderr, "BPyMenus error: Unknown group \"%s\": %s\n",
middle, fname);
parser_state = 0;
}
else { /* register script */
scriptMenu = bpymenu_AddEntry((short)script_group,
(short int)script_version, script_name, fname, is_userdir,NULL);
if (scriptMenu == NULL) {
if (DEBUG)
fprintf(stderr,
"BPyMenus error: Couldn't create entry for: %s\n", fname);
parser_state = 0;
} else {
parser_state++;
}
}
} else {
if (DEBUG)
fprintf(stderr, "BPyMenus error: Wrong 'Group' line: %s\n",fname);
parser_state = 0;
}
break;
case 6: /* optional elements */
/* Submenu: 'submenu name' related_1word_arg */
matches = sscanf(line, "%[^']'%[^']'%s\n", head, middle, tail);
if ((matches == 3) && (strstr(head, "Submenu:") != NULL)) {
bpymenu_AddSubEntry(scriptMenu, middle, tail);
} else {
/* Tooltip: 'tooltip for the menu */
matches = sscanf(line, "%[^']'%[^']'%c", head, middle, tail);
if ((matches == 3) && ((strstr(head, "Tooltip:") != NULL) ||
(strstr(head, "Tip:") != NULL))) {
bpymenu_set_tooltip(scriptMenu, middle);
}
parser_state = 0;
}
break;
default:
parser_state = 0;
break;
}
}
}
else { /* shouldn't happen, it's checked in bpymenus_ParseDir */
if (DEBUG)
fprintf(stderr, "BPyMenus error: Couldn't open %s.\n", fname);
return -1;
}
return 0;
}
/* bpymenu_ParseDir:
* recursively scans folders looking for scripts to register.
*
* This function scans the scripts directory looking for .py files with the
* right header and menu info.
* - is_userdir defines if the script is in the default scripts dir or the
* user defined one (U.pythondir: is_userdir == 1);
* - parentdir is the parent dir name to store as part of the script filename,
* if we're down a subdir.
* Speed is important.
*/
static int bpymenu_ParseDir(char *dirname, char *parentdir, int is_userdir )
{
DIR *dir;
FILE *file = NULL;
struct dirent *de;
struct stat status;
char *file_extension;
char path[FILE_MAX];
char subdir[FILE_MAX];
char *s = NULL;
dir = opendir(dirname);
if (dir != NULL) {
while ((de = readdir(dir)) != NULL) {
/* skip files and dirs starting with '.' or 'bpy' */
if ((de->d_name[0] == '.') || !strncmp(de->d_name, "bpy", 3)) {
continue;
}
BLI_make_file_string("/", path, dirname, de->d_name);
if (stat(path, &status) != 0) {
if (DEBUG)
fprintf(stderr, "stat %s failed: %s\n", path, strerror(errno));
}
if (S_ISREG(status.st_mode)) { /* is file */
file_extension = strstr(de->d_name, ".py");
if (file_extension && *(file_extension + 3) == '\0') {
file = fopen(path, "rb");
if (file) {
s = de->d_name;
if (parentdir) {
/* Join parentdir and de->d_name */
BLI_join_dirfile(subdir, parentdir, de->d_name);
s = subdir;
}
bpymenu_ParseFile(file, s, is_userdir);
fclose(file);
}
else {
if (DEBUG)
fprintf(stderr, "BPyMenus error: Couldn't open %s.\n", path);
}
}
}
else if (S_ISDIR(status.st_mode)) { /* is subdir */
Dirs_Number++;
Dir_Depth++;
if (Dirs_Number > MAX_DIR_NUMBER) {
if (DEBUG) {
fprintf(stderr, "BPyMenus error: too many subdirs.\n");
}
closedir(dir);
return -1;
}
else if (Dir_Depth > MAX_DIR_DEPTH) {
if (DEBUG)
fprintf(stderr,
"BPyMenus error: max depth reached traversing dir tree.\n");
closedir(dir);
return -1;
}
s = de->d_name;
if (parentdir) {
/* Join parentdir and de->d_name */
BLI_join_dirfile(subdir, parentdir, de->d_name);
s = subdir;
}
if (bpymenu_ParseDir(path, s, is_userdir) == -1) {
closedir(dir);
return -1;
}
Dir_Depth--;
}
}
closedir(dir);
}
else { /* open directory stream failed */
if (DEBUG)
fprintf(stderr, "opendir %s failed: %s\n", dirname, strerror(errno));
return -1;
}
return 0;
}
static int bpymenu_GetStatMTime( const char *name, int is_file, time_t * mtime )
{
struct stat st;
int result;
#ifdef WIN32
if (is_file) {
result = stat( name, &st );
} else {
/* needed for win32 only, remove trailing slash */
char name_stat[FILE_MAX];
BLI_strncpy(name_stat, name, FILE_MAX);
BLI_del_slash(name_stat);
result = stat( name_stat, &st );
}
#else
result = stat( name, &st );
#endif
if( result == -1 )
return -1;
if( is_file ) {
if( !S_ISREG( st.st_mode ) )
return -2;
} else if( !S_ISDIR( st.st_mode ) )
return -2;
*mtime = st.st_mtime;
return 0;
}
/* BPyMenu_Init:
* import the bpython menus data to Blender, either from:
* - the BPYMENU_DATAFILE file (?/.blender/Bpymenus) or
* - the scripts dir(s), case newer than the datafile (then update the file).
* then fill the bpymenu table with this data.
* if param usedir != 0, then the data is recreated from the dir(s) anyway.
*/
int BPyMenu_Init( int usedir )
{
char fname[FILE_MAXDIR];
char dirname[FILE_MAXDIR];
char upythondir[FILE_MAXDIR];
char *upydir = U.pythondir, *sdir = NULL;
time_t time_dir1 = 0, time_dir2 = 0, time_file = 0;
int stat_dir1 = 0, stat_dir2 = 0, stat_file = 0;
int i;
DEBUG = G.f & G_DEBUG; /* is Blender in debug mode (started with -d) ? */
/* init global bpymenu table (it is a list of pointers to struct BPyMenus
* for each available group: import, export, etc.) */
for( i = 0; i < PYMENU_TOTAL; i++ )
BPyMenuTable[i] = NULL;
if( DEBUG )
fprintf(stdout, "\nRegistering scripts in Blender menus ...\n\n" );
if( U.pythondir[0] == '\0') {
upydir = NULL;
}
else if (strcmp(U.pythondir, "/") == 0 || strcmp(U.pythondir, "//") == 0) {
/* these are not accepted to prevent possible slight slowdowns on startup;
* they should not be used as user defined scripts dir, anyway, also from
* speed considerations, since they'd not be dedicated scripts dirs */
if (DEBUG) fprintf(stderr,
"BPyMenus: invalid user defined Python scripts dir: \"/\" or \"//\".\n");
upydir = NULL;
}
else {
BLI_strncpy(upythondir, upydir, FILE_MAXDIR);
BLI_convertstringcode(upythondir, G.sce, 0);
}
sdir = bpy_gethome(1);
if (sdir) {
BLI_strncpy(dirname, sdir, FILE_MAXDIR);
stat_dir1 = bpymenu_GetStatMTime( dirname, 0, &time_dir1 );
if( stat_dir1 < 0 ) {
time_dir1 = 0;
if( DEBUG ) {
fprintf(stderr,
"\nDefault scripts dir: %s:\n%s\n", dirname, strerror(errno));
if( upydir )
fprintf(stdout,
"Getting scripts menu data from user defined dir: %s.\n",
upythondir );
}
}
}
else stat_dir1 = -1;
if( upydir ) {
stat_dir2 = bpymenu_GetStatMTime( upythondir, 0, &time_dir2 );
if( stat_dir2 < 0 ) {
time_dir2 = 0;
upydir = NULL;
if( DEBUG )
fprintf(stderr, "\nUser defined scripts dir: %s:\n%s.\n",
upythondir, strerror( errno ) );
if( stat_dir1 < 0 ) {
if( DEBUG )
fprintf(stderr, "\
To have scripts in menus, please add them to the default scripts dir:\n\
%s\n\
and / or go to 'Info window -> File Paths tab' and set a valid path for\n\
the user defined Python scripts dir.\n", dirname );
return -1;
}
}
}
else stat_dir2 = -1;
if( ( stat_dir1 < 0 ) && ( stat_dir2 < 0 ) ) {
if( DEBUG ) {
fprintf(stderr, "\nCannot register scripts in menus, no scripts dir"
" available.\nExpected default dir at: %s \n", dirname );
}
return -1;
}
if (usedir) stat_file = -1;
else { /* if we're not forced to use the dir */
char *homedir = bpy_gethome(0);
if (homedir) {
BLI_make_file_string( "/", fname, homedir, BPYMENU_DATAFILE );
stat_file = bpymenu_GetStatMTime( fname, 1, &time_file );
if( stat_file < 0 )
time_file = 0;
/* comparing dates */
if((stat_file == 0)
&& (time_file > time_dir1) && (time_file > time_dir2))
{ /* file is newer */
stat_file = bpymenu_CreateFromFile( ); /* -1 if an error occurred */
if( !stat_file && DEBUG )
fprintf(stdout,
"Getting menu data for scripts from file:\n%s\n\n", fname );
}
else stat_file = -1;
}
else stat_file = -1; /* -1 to use dirs: didn't use file or it was corrupted */
}
if( stat_file == -1 ) { /* use dirs */
if( DEBUG ) {
fprintf(stdout,
"Getting menu data for scripts from dir(s):\ndefault: %s\n", dirname );
if( upydir )
fprintf(stdout, "user defined: %s\n", upythondir );
fprintf(stdout, "\n");
}
if( stat_dir1 == 0 ) {
i = bpymenu_ParseDir( dirname, NULL, 0 );
if (i == -1 && DEBUG)
fprintf(stderr, "Default scripts dir does not seem valid.\n\n");
}
if( stat_dir2 == 0 ) {
BLI_strncpy(dirname, U.pythondir, FILE_MAXDIR);
BLI_convertstringcode(dirname, G.sce, 0);
i = bpymenu_ParseDir( dirname, NULL, 1 );
if (i == -1 && DEBUG)
fprintf(stderr, "User defined scripts dir does not seem valid.\n\n");
}
/* check if we got any data */
for( i = 0; i < PYMENU_TOTAL; i++ )
if( BPyMenuTable[i] )
break;
/* if we got, recreate the file */
if( i < PYMENU_TOTAL )
bpymenu_WriteDataFile( );
else if( DEBUG ) {
fprintf(stderr, "\n\
Warning: Registering scripts in menus -- no info found.\n\
Either your scripts dirs have no .py scripts or the scripts\n\
don't have a header with registration data.\n\
Default scripts dir is:\n\
%s\n", dirname );
if( upydir )
fprintf(stderr, "User defined scripts dir is: %s\n",
upythondir );
}
}
return 0;
}
|