-
Notifications
You must be signed in to change notification settings - Fork 1
/
weaver_program.tex
1845 lines (1613 loc) · 61 KB
/
weaver_program.tex
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
\font\sixteen=cmbx16
\font\twelve=cmr12
\font\fonteautor=cmbx12
\font\fonteemail=cmtt10
\font\twelvenegit=cmbxti12
\font\twelvebold=cmbx12
\font\trezebold=cmbx13
\font\twelveit=cmsl12
\font\monodoze=cmtt12
\font\it=cmti12
\voffset=0,959994cm % 3,5cm de margem superior e 2,5cm inferior
\parskip=6pt
\def\titulo#1{{\noindent\sixteen\hbox to\hsize{\hfill#1\hfill}}}
\def\autor#1{{\noindent\fonteautor\hbox to\hsize{\hfill#1\hfill}}}
\def\email#1{{\noindent\fonteemail\hbox to\hsize{\hfill#1\hfill}}}
\def\negrito#1{{\twelvebold#1}}
\def\italico#1{{\twelveit#1}}
\def\monoespaco#1{{\monodoze#1}}
\def\iniciocodigo{\lineskip=0pt\parskip=0pt}
\def\fimcodigo{\twelve\parskip=0pt plus 1pt\lineskip=1pt}
\long\def\abstract#1{\parshape 10 0.8cm 13.4cm 0.8cm 13.4cm
0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm
0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm
\noindent{{\twelvenegit Abstract: }\twelveit #1}}
\def\resumo#1{\parshape 10 0.8cm 13.4cm 0.8cm 13.4cm
0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm
0.8cm 13.4cm 0.8cm 13.4cm 0.8cm 13.4cm
\noindent{{\twelvenegit Resumo: }\twelveit #1}}
\def\secao#1{\vskip12pt\noindent{\trezebold#1}\parshape 1 0cm 15cm}
\def\subsecao#1{\vskip12pt\noindent{\twelvebold#1}}
\def\referencia#1{\vskip6pt\parshape 5 0cm 15cm 0.5cm 14.5cm 0.5cm 14.5cm
0.5cm 14.5cm 0.5cm 14.5cm {\twelve\noindent#1}}
%@* .
\twelve
\vskip12pt
\titulo{O Programa Weaver}
\vskip12pt
\autor{Thiago Leucz Astrizi}
\vskip6pt
\email{thiago@@bitbitbit.com.br}
\vskip6pt
\abstract{This article describes using literary programming the
program Weaver. This program is a project manager for the Weaver
Game Engine. If a user wants to create a new game with the Weaver
Game Engine, they use this program to create the directory structure
for a new game project. They also use this program to add new source
files and shader files to a game project. And to update a project
with a more recent Weaver version installed in the computer. The
presenting code in C is cross-platform and should work under
Windows, Linux, OpenBSD and possibly other Unix variants.}
\vskip 0.5cm plus 3pt minus 3pt
\resumo{Este artigo descreve usando programação literária o programa
Weaver. Este programa é um gerenciador de projetos para o Motor de
Jogos Weaver. Se alguém deseja criar um novo projeto com o motor de
jogos, usará este programa para criar a estrutura de diretórios
desejada. Também usará o programa para adicionar novos arquivos de
código-fonte e shaders. Para atualizar um projeto pré-existente com
uma nova versão de Weaver, o programa também é necessário. O código
seguinte em C será multi-plataforma e deverá funcionar em Windows,
Linux, OpenBSD e possivelmente outras variantes de Unix.}
\secao{1. Introdução}
Um motor de jogos é formado por um conjunto de bibliotecas e funções
que auxiliam na criação de jogos fornecendo as funcionalidades mais
comus para este tipo de desenvolvimento. Mas além das bibliotecas e
funções, deve existir um gerenciador responsável por fazer com que o
seu código utilize as bibliotecas a maneira adequada e faça as
inicializações necessárias.
O motor de jogos Weaver tem pré-requisitos bastante estritos de como o
diretório que contém um projeto Weaver deve estar organizado. É para
cumprir erstes requisitos que o programa que será apresentado é
necessário. Ele inicializa da maneira correta a estrutura de
diretórios de um novo projeto. Ele adiciona novos arquivos fonte já
com quaisquer código necessário para sua integração. E por controlar o
projeto desta forma, ele saberá atualizar as bibliotecas para versões
mais recentes se necessário.
O uso deste programa será por mieo de linha de comando. Por exemplo,
se um usuário usar o comando ``\monoespaco{weaver pong}'', será criada
uma estrutura de diretórios semelhante à mostrada na imagem que
ilustra o fim da seção com um novo projeto chamado ``pong''.
\imagem{cweb/diagrams/project_dir.eps}
As seguintes seções do artigo estão organizadas da seguinte forma. A
seção 2 abordará a licensa do software. A seção 3 listará as variáveis
usadas para controlar seu comportamento. A seção 4 trará algumas
macros que usaremos, algumas das quais apareceram na estrutura do
programa. A seção 5 apresentará algumas funções auxiliares que
utilizaremos. A seção 6 mostrará a inicialização das variáveis do
programa. A seção 7 mostrará os casos de uso do programa e como
implementá-los após termos as variáveis com os valores certos.
\secao{2. Copyright e licenciamento}
Segue abaixo a licença do programa e sua tradução não-oficial:
\espaco{5mm}\linha
\alinhaverbatim
Copyright (c) Thiago Leucz Astrizi 2015
This program is free software: you can redistribute it and/or
modify it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.
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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public
License along with this program. If not, see
<http://www.gnu.org/licenses/>.
\linha
Copyright (c) Thiago Leucz Astrizi 2015
Este programa é um software livre; você pode redistribuí-lo e/ou
modificá-lo dentro dos termos da Licença Pública Geral GNU Affero como
publicada pela Fundação do Software Livre (FSF); na versão 3 da
Licença, ou (na sua opinião) qualquer versão.
Este programa é distribuído na esperança de que possa ser útil,
mas SEM NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO
a qualquer MERCADO ou APLICAÇÃO EM PARTICULAR. Veja a
Licença Pública Geral GNU Affero para maiores detalhes.
Você deve ter recebido uma cópia da Licença Pública Geral GNU Affero
junto com este programa. Se não, veja
<http://www.gnu.org/licenses/>.
\alinhanormal
\linha\espaco{5mm}
A versão completa da licença pode ser obtida junto ao código-fonte
Weaver ou consultada no link mencionado.
\secao{3. Variáveis e Estrutura do Programa Weaver}
O comportamento de Weaver deve depender das seguintes variáveis:
|inside_weaver_directory|: Indicará se o programa está sendo
invocado de dentro de um projeto Weaver.
|argument|: O primeiro argumento, ou NULL se ele não existir
|argument2|: O segundo argumento, ou NULL se não existir.
|project_version_major|: Se estamos em um projeto Weaver, qual o
maior número da versão do Weaver usada para gerar o
projeto. Exemplo: se a versão for 0.5, o número maior é 0. Em
versões de teste, o valor é sempre 0.
|project_version_minor|: Se estamos em um projeto Weaver, o valor
do menor número da versão do Weaver usada para gerar o
projeto. Exemplo, se a versão for 0.5, o número menor é 5. Em
versões de teste o valor é sempre 0.
|weaver_version_major|: O número maior da versão do Weaver sendo
usada no momento.
|weaver_version_minor|: O número menor da versão do Weaver sendo
usada no momento.
|arg_is_path|: Se o primeiro argumento é ou não um caminho
absoluto ou relativo para um projeto Weaver.
|arg_is_valid_project|: Se o argumento passado seria válido como
nome de projeto Weaver.
|arg_is_valid_module|: Se o argumento passado seria válido como
um novo módulo no projeto Weaver atual.
|arg_is_valid_function|: Se o segundo argumento existe e se ele seria
um nome válido para um loop principal e também para um arquivo.
|project_path|: Se estamos dentro de um diretório de projeto
Weaver, qual o caminho para a sua base (onde há o Makefile)
|have_arg|: Se o programa é invocado com argumento.
|shared_dir|: Deverá armazenar o caminho para o diretório onde estão
os arquivos compartilhados da instalação de Weaver. Por padrão, será
igual à ``\monoespaco{/usr/local/share/weaver}'' em sistemas Unix e
dentro de subpasta em ``Arquivos de Programas'' no Windows. Isso
pode ser mudado durante a compilação definindo a
macro \monoespaco{WEAVER\_DIR}.
|author_name|,|project_name| e |year|: Conterão respectivamente o
nome do usuário que está invocando Weaver, o nome do projeto atual
(se estivermos no diretório de um) e o ano atual. Isso será
importante para gerar as mensagens de Copyright em novos projetos
Weaver.
|return_value|: Que valor o programa deve retornar caso o programa
seja interrompido no momento atual.
A estrutura geral do programa com a declaração de todas as variáveis
será:
\iniciocodigo
@(src/weaver.c@>=
@<Cabeçalhos Incluídos no Programa Weaver@>
@<Macros do Programa Weaver@>
@<Funções auxiliares Weaver@>
int main(int argc, char **argv){@/
int return_value = 0; /* Valor de retorno. */
bool inside_weaver_directory = false, arg_is_path = false,
arg_is_valid_project = false, arg_is_valid_module = false,
have_arg = false,
arg_is_valid_function = false; /* Variáveis booleanas. */
unsigned int project_version_major = 0, project_version_minor = 0,
weaver_version_major = 0, weaver_version_minor = 0,
year = 0;
/* Strings UTF-8: */
char *argument = NULL, *project_path = NULL, *shared_dir = NULL,
*author_name = NULL, *project_name = NULL, *argument2 = NULL;
@<Inicialização@>
@<Caso de uso 1: Imprimir ajuda (criar projeto)@>
@<Caso de uso 2: Imprimir ajuda de gerenciamento@>
@<Caso de uso 3: Mostrar versão@>
@<Caso de uso 4: Atualizar projeto Weaver@>
@<Caso de uso 5: Criar novo módulo@>
@<Caso de uso 6: Criar novo projeto@>
@<Caso de uso 7: Criar novo loop principal@>
END_OF_PROGRAM:
@<Finalização@>
return return_value;
}
@
\fimcodigo
\secao{4. Macros e Cabeçalhos do Programa Weaver}
O programa precisará de algumas macros. A primeira delas deverá conter
uma string com a versão do programa. A versão pode ser formada só por
letras (no caso de versões de teste) ou por um número seguido de um
ponto e de outro número (sem espaços) no caso de uma versão final do
programa.
Para a segunda macro, observe que na estrutura geral do programa vista
acima existe um rótulo chamado |END_OF_PROGRAM| logo na parte de
finalização. Uma das formas de chegarmos lá é por meio da execução
normal do programa, caso nada dê errado. Entretanto, no caso de um
erro, nós podemos também chegar lá por meio de um desvio incondicional
após imprimirmos a mensagem de erro e ajustarmos o valor de retorno do
programa. A responsabilidade de fazer isso será da segunda macro.
Por outro lado, podemos também querer encerrar o programa previamente,
mas sem que tenha havido um erro. A responsabilidade disso é da
terceira macro que definimos.
\iniciocodigo
@<Macros do Programa Weaver@>=
#define VERSION "Alpha"
#define W_ERROR() {perror(NULL); return_value = 1; goto END_OF_PROGRAM;}
#define END() goto END_OF_PROGRAM;
@
\fimcodigo
Como estamos usando a função de biblioteca \monoespaco{perror},
devemos incluir o cabeçalho \monoespaco{stdio.h}, o que também nos
trará s funções de imprimir na tela, abrir e fechar arquivos e
escrever neles, o que nos será útil. Vamos inserir suporte à valores
booleanos que usamos na própria estrutura do programa e também a
biblioteca padrão, que tem funções como |exit| usadas na estrutura do
programa.
Se estivermos rodando no Windows, queremos também suprimir alguns
avisos sobre uso de funções \monoespaco{fopen} ao invés
de \monoespaco{fopen\_s}, por exemplo. Isso porque as funções seguras
do Windows não são portáveis e usamos as funções antigas de maneira
controlada. Para suprimir tais avisos, precisamos definir a macro
específica abaixo antes de incluir os demais cabeçalhos.
\iniciocodigo
@<Cabeçalhos Incluídos no Programa Weaver@>=
#if defined(_WIN32)
#define _CRT_SECURE_NO_WARNING
#endif
#include <stdio.h> // printf, fprintf, fopen, fclose, fgets, fgetc, perror
#include <stdbool.h> // bool, true, false
#include <stdlib.h> // free, exit, getenv
@
\fimcodigo
\secao{5. Funções Auxiliares}
Listemos aqui algumas funções que usaremos ao longo do programa para
facilitar sua descrição.
\subsecao{5.1. path\_up: Manipula Caminho}
Para manipularmos o caminho da árvore de diretórios, usaremos uma
função auxiliar que recebe como entrada uma string com um caminho na
árvore de diretórios e apaga todos os últimos caracteres até apagar
dois ``/''. Assim em ``/home/alice/projeto/diretorio/'' ele retornaria
``/home/alice/projeto'' efetivamente subindo um nível na árvore de
diretórios.
É importante lembrar que no Windows o separador não é o ``/'', mas o
``\\''. Então vamos tratar o separador de forma diferente de acordo
com o sistema:
\iniciocodigo
@<Funções auxiliares Weaver@>=
void path_up(char *path){
#if !defined(_WIN32)
char separator = '/';
#else
char separator = '\\';
#endif
int erased = 0;
char *p = path;
while(*p != '\0') p ++; // Vai até o fim
while(erased < 2 && p != path){
p --;
if(*p == separator) erased ++;
*p = '\0'; // Apaga
}
}
@
\fimcodigo
Note que caso a função receba uma string que não possua dois ``/'' em
seu nome, acabamos apagando toda a string. Neste programa limitaremos
o uso desta função a strings com caminhos de arquivos que não estão na
raíz e diretórios diferentes da própria raíz que terminam sempre com
``/'', então não teremos problemas pois a restrição do número de
barras será cumprida. Ex: ``/etc/'' e ``/tmp/file.txt''.
\subsecao{5.2. directory\_exists: Arquivo existe e é diretório}
Para checar se o diretório \monoespaco{.weaver} existe, definimos
|directory_exist(x)| como uma função que recebe uma string
correspondente à localização de um arquivo e que deve retornar 1 se
|x| for um diretório existente, -1 se |x| for um arquivo existente e 0
caso contrário. Primeiro criamos as macros para não nos esquecermos do
que significa cada número de retorno:
\iniciocodigo
@<Macros do Programa Weaver@>+=
#define NAO_EXISTE 0
#define EXISTE_E_EH_DIRETORIO 1
#define EXISTE_E_EH_ARQUIVO -1
@
\fimcodigo
\iniciocodigo
@<Funções auxiliares Weaver@>+=
int directory_exist(char *dir){
#if !defined(_WIN32)
// Unix:
struct stat s; // Armazena status se um diretório existe ou não.
int err; // Checagem de erros
err = stat(dir, &s); // .weaver existe?
if(err == -1) return NAO_EXISTE;
if(S_ISDIR(s.st_mode)) return EXISTE_E_EH_DIRETORIO;
return EXISTE_E_EH_ARQUIVO;
#else
// Windows:
DWORD dwAttrib = GetFileAttributes(dir);
if(dwAttrib == INVALID_FILE_ATTRIBUTES) return NAO_EXISTE;
if(!(dwAttrib & FILE_ATTRIBUTE_DIRECTORY)) return EXISTE_E_EH_ARQUIVO;
else return EXISTE_E_EH_DIRETORIO;
#endif
}
@
\fimcodigo
Dependendo de estarmos no Windows ou em sistemas Unix, usamos funções
diferentes e vamos precisar de cabeçalhos diferentes:
\iniciocodigo
@<Cabeçalhos Incluídos no Programa Weaver@>=
#if !defined(_WIN32)
#include <sys/types.h> // stat, getuid, getpwuid, mkdir
#include <sys/stat.h> // stat, mkdir
#else
#include <windows.h> // GetFileAttributes, ...
#endif
@
\fimcodigo
\subsecao{5.3. concatenate: Concatena strings}
Esta função deve receber um número arbitrário de srings como
argumento, mas a última string deve ser uma string vazia ou |NULL|. E
irá retornar a concatenação de todas as strings passadas como
argumento. A função irá alocar sempre uma nova string, a qual deverá
ser desalocada antes do programa terminar. Como exemplo,
|concatenate("tes", " ", "te", "")| retorna |"tes te"|.
\iniciocodigo
@<Funções auxiliares Weaver@>+=
char *concatenate(char *string, ...){
va_list arguments;
char *new_string, *current_string = string;
size_t current_size = strlen(string) + 1;
char *realloc_return;
va_start(arguments, string);
new_string = (char *) malloc(current_size);
if(new_string == NULL) return NULL;
// Copia primeira string para região a ser concatenada
memcpy(new_string, string, current_size);
while(current_string != NULL && current_string[0] != '\0'){
size_t increment_length, last_length;
current_string = va_arg(arguments, char *);
increment_length = strlen(current_string);
last_length = current_size;
current_size += increment_length;
realloc_return = (char *) realloc(new_string, current_size);
if(realloc_return == NULL){
free(new_string);
return NULL;
}
new_string = realloc_return;
// Copiando próxima string
memcpy(&(new_string[last_length-1]), current_string, increment_length + 1);
}
return new_string;
}
@
\fimcodigo
É importante lembrarmos que a função |concatenate| sempre deve receber
como último argumento uma string vazia ou teremos um \italico{buffer
overflow}. Esta função é perigosa e deve ser usada sempre tomando-se
este cuidado.
O uso desta função requer que usemos o seguinte cabeçalho:
\iniciocodigo
@<Cabeçalhos Incluídos no Programa Weaver@>=
#include <string.h> // strcmp, strcat, strcpy, strncmp
#include <stdarg.h> // va_start, va_arg
@
\fimcodigo
\subsecao{5.4. basename: Obtém o nome de um arquivo dado seu caminho}
Esta função já existe em sistemas Unix. Dado o caminho completo para
um arquivo, ela retorna uma string apenas com o nome do arquivo. Ela
não precisa alocar uma nova string, ela retorna um ponteiro para o
nome do arquivo dentro do próprio caminho recebido como argumento.
Vamos defini-la agora para sistemas Windows:
\iniciocodigo
@<Funções auxiliares Weaver@>+=
#if defined(_WIN32)
char *basename(char *path){
char *p = path;
char *last_delimiter = NULL;
while(*p != '\0'){
if(*p == '\\')
last_delimiter = p;
p ++;
}
if(last_delimiter != NULL)
return last_delimiter + 1;
else
return path;
}
#endif
@
\fimcodigo
Mesmo que não precisemos definir esta função em sistemas Unix, ainda
precisamos incluí-la com o cabeçalho:
\iniciocodigo
@<Cabeçalhos Incluídos no Programa Weaver@>=
#if !defined(_WIN32)
#include <libgen.h>
#endif
@
\fimcodigo
\subsecao{5.5. copy\_single\_file: Copia um único arquivo para diretório}
A função |copy_single_file| tenta copiar o
arquivo cujo caminho é o primeiro argumento para o diretório cujo
caminho é o segundo argumento. Se ela conseguir, retorna 1 e retorna 0
caso contrário.
\iniciocodigo
@<Funções auxiliares Weaver@>+=
int copy_single_file(char *file, char *directory){
int block_size, bytes_read;
char *buffer, *file_dst;
FILE *orig, *dst;
// Inicializa 'block_size':
@<Descobre tamanho do bloco do sistema de arquivos@>
buffer = (char *) malloc(block_size); // Aloca buffer de cópia
if(buffer == NULL) return 0;
file_dst = concatenate(directory, "/", basename(file), "");
if(file_dst == NULL) return 0;
orig = fopen(file, "r"); // Abre arquivo de origem
if(orig == NULL){
free(buffer);
free(file_dst);
return 0;
}
dst = fopen(file_dst, "w"); // Abre arquivo de destino
if(dst == NULL){
fclose(orig);
free(buffer);
free(file_dst);
return 0;
}
while((bytes_read = fread(buffer, 1, block_size, orig)) > 0){
fwrite(buffer, 1, bytes_read, dst); // Copia origem -> buffer -> destino
}
fclose(orig);
fclose(dst);
free(file_dst);
free(buffer);
return 1;
}
@
\fimcodigo
O mais eficiente é que o buffer usado para copiar arquivos tenha o
mesmo tamanho do bloco do sistema de arquivos. Para obter o valor
correto deste tamanho, usamos o seguinte trecho de código em sistemas
Unix:
\iniciocodigo
@<Descobre tamanho do bloco do sistema de arquivos@>=
#if !defined(_WIN32)
{
struct stat s;
stat(directory, &s);
block_size = s.st_blksize;
if(block_size <= 0){
block_size = 4096;
}
}
#endif
@
\fimcodigo
No Windows nós apenas iremos assumir que o tamanho é 4 KB:
\iniciocodigo
@<Descobre tamanho do bloco do sistema de arquivos@>+=
#if defined(_WIN32)
block_size = 4096;
#endif
@
\fimcodigo
\subsecao{5.6. copy\_files: Copia todos os arquivos de origem para destino}
De posse da função que copia um só arquivo, precisamos definir uma
função para copiar todos os arquivos de dentro de um diretório para
outro recursivamente. Isso é algo trabalhoso, pois precisamos listar
todo o conteúdo de um diretório para obter seus arquivos. Como fazer
isso varia dependendo do sistema operacional.
Em sistemas Unix a função usará |readdir| para ler o conteúdo de
arquivos:
\iniciocodigo
@<Funções auxiliares Weaver@>+=
#if !defined(_WIN32)
int copy_files(char *orig, char *dst){
DIR *d = NULL;
struct dirent *dir;
d = opendir(orig);
if(d){
while((dir = readdir(d)) != NULL){ // Loop para ler cada arquivo
char *file;
file = concatenate(orig, "/", dir -> d_name, "");
if(file == NULL){
return 0;
}
#if (defined(__linux__) || defined(_BSD_SOURCE)) && defined(DT_DIR)
// Se suportamos DT_DIR, não precisamos chamar a função 'stat':
if(dir -> d_type == DT_DIR){
#else
struct stat s;
int err;
err = stat(file, &s);
if(err == -1) return 0;
if(S_ISDIR(s.st_mode)){
#endif
// Se concluirmos estar lidando com subdiretório via 'stat' ou 'DT_DIR':
char *new_dst;
new_dst = concatenate(dst, "/", dir -> d_name, "");
if(new_dst == NULL){
return 0;
}
if(strcmp(dir -> d_name, ".") && strcmp(dir -> d_name, "..")){
if(directory_exist(new_dst) == NAO_EXISTE) mkdir(new_dst, 0755);
if(copy_files(file, new_dst) == 0){
free(new_dst);
free(file);
closedir(d);
return 0;
}
}
free(new_dst);
}
else{
// Se concluimos estar diante de um arquivo usual:
if(copy_single_file(file, dst) == 0){
free(file);
closedir(d);
return 0;
}
}
free(file);
} // Fim do loop para ler cada arquivo
closedir(d);
}
return 1;
}
#endif
@
\fimcodigo
E isso requer inserir o cabeçalho:
\iniciocodigo
@<Cabeçalhos Incluídos no Programa Weaver@>=
#if !defined(_WIN32)
#include <dirent.h> // readdir, opendir, closedir
#endif
@
\fimcodigo
No Windows, não é necessário inserir nenhum cabeçalho novo que já não
está inserido. A definição da função fica assim:
\iniciocodigo
@<Funções auxiliares Weaver@>+=
#if defined(_WIN32)
int copy_files(char *orig, char *dst){
char *path, *search_path;
WIN32_FIND_DATA file;
HANDLE dir = NULL;
search_path = concatenate(orig, "\\*", "");
if(search_path == NULL)
return 0;
dir = FindFirstFile(search_path, &file);
if(dir != INVALID_HANDLE_VALUE){
// The first file shall be '.' and should be safely ignored
do{
if(strcmp(file.cFileName, ".") && strcmp(file.cFileName, "..")){
path = concatenate(orig, "\\", file.cFileName, "");
if(path == NULL){
free(search_path);
return 0;
}
if(file.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY){
char *dst_path;
dst_path = concatenate(dst, "\\", file.cFileName, "");
if(directory_exist(dst_path) == NAO_EXISTE)
CreateDirectoryA(dst_path, NULL);
if(copy_files(path, dst_path) == 0){
free(dst_path);
free(path);
FindClose(dir);
free(search_path);
return 0;
}
free(dst_path);
}
else{ // file
if(copy_single_file(path, dst) == 0){
free(path);
FindClose(dir);
free(search_path);
return 0;
}
}
free(path);
}
}while(FindNextFile(dir, &file));
}
free(search_path);
FindClose(dir);
return 1;
}
#endif
@
\fimcodigo
\subsecao{5.7. write\_copyright: Escreve mensagem de copyright em arquivo}
Por padrão, projetos Weaver utilizam a licença GNU GPL3. Como códigos
sob esta licença são copiados e usados estaticamente em novos
projetos, eles precisam necessariamente ter uma licença igual ou
compatível.
O código é bastante simples e requer apenas alguns parâmetros com o
nome do autor e ano atual:
\iniciocodigo
@<Funções auxiliares Weaver@>+=
void write_copyright(FILE *fp, char *author_name, char *project_name, int year){
char license[] = "/*\nCopyright (c) %s, %d\n\nThis file is part of %s.\n\n%s\
is free software: you can redistribute it and/or modify\nit under the terms of\
the GNU Affero General Public License as published by\nthe Free Software\
Foundation, either version 3 of the License, or\n(at your option) any later\
version.\n\n\
%s is distributed in the hope that it will be useful,\nbut WITHOUT ANY\
WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS\
FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more\
details.\n\nYou should have received a copy of the GNU Affero General Public License\
\nalong with %s. If not, see <http://www.gnu.org/licenses/>.\n*/\n\n";
fprintf(fp, license, author_name, year, project_name, project_name,
project_name, project_name);
}
@
\fimcodigo
\subsecao{5.8. create\_dir: Cria novos diretórios}
Esta é a função responsável por criar uma lista de diretórios. Isso é
algo bastante simples, mas deve ficar encapsulado em sua própria
função por causa das diferenças entre Sistemas Operacionais sobre como
realizar a tarefa.
Esta função deve receber uma lista variável de strings como argumento,
sendo que o último argumento precisa ser uma string vazia ou
NULL. Para cada argumento representando um caminho, a função criará o
diretório no caminho especificado. Por padrão, usaremos como separador
em caminhos será o ``\monoespaco{/}'', de modo que isso fará a função
funcionar tanto em sistemas Unix como no Windows, onde a sua
função \monoespaco{CreateDirectoryA} entende caminhos passados com o
separador Unix.
Em sistemas Unix nós precisamos também especificar as permissões
máximas que o diretório terá em termos de leitura, escrita e
execução. Tais permissões podem ser mais restritas de acordo com a
configuração do sistema. No Windows, que tem um sistema de permissões
mais hierárquica, nós apenas herdamos as permissões do diretório pai.
Em caso de erro, nós retornaremos -1. Se tudo deu certo, retornamos 1.
A definição de nossa função será então:
\iniciocodigo
@<Funções auxiliares Weaver@>+=
int create_dir(char *string, ...){
char *current_string;
va_list arguments;
va_start(arguments, string);
int err = 1;
current_string = string;
while(current_string != NULL && current_string[0] != '\0' && err != -1){
#if !defined(_WIN32)
err = mkdir(current_string, S_IRWXU | S_IRWXG | S_IROTH);
#else
if(!CreateDirectoryA(current_string, NULL))
err = -1;
#endif
current_string = va_arg(arguments, char *);
}
return err;
}
@
\fimcodigo
\subsecao{5.9. append\_file: Concatena um arquivo no outro}
Esta será uma função diferente, pois ela será mais focada em resolver
de maneira eficiente um único caso de uso do que apresentar uma
interface intuitiva e consistente. Ela irá receber como entrada um
ponteiro para um arquivo já aberto (iremos chamar esta função depois
de já termos aberto o arquivo para escrever o copyright) e receberá
dois outros argumentos: o diretório em que está o arquivo de origem e
o nome do arquivo de origem, separados em duas strings. Dessa forma, o
trabalho de concatenar as duas coisas fica com esta função, não com
quem a está invocando.
Sua definição será:
\iniciocodigo
@<Funções auxiliares Weaver@>+=
int append_file(FILE *fp, char *dir, char *file){
int block_size, bytes_read;
char *buffer, *directory = ".";
char *path = concatenate(dir, file, "");
if(path == NULL) return 0;
FILE *origin;
@<Descobre tamanho do bloco do sistema de arquivos@>
buffer = (char *) malloc(block_size);
if(buffer == NULL){
free(path);
return 0;
}
origin = fopen(path, "r");
if(origin == NULL){
free(buffer);
free(path);
return 0;
}
while((bytes_read = fread(buffer, 1, block_size, origin)) > 0){
fwrite(buffer, 1, bytes_read, fp);
}
fclose(origin);
free(buffer);
free(path);
return 1;
}
@
\fimcodigo
\secao{6. Inicialização das Variáveis}
\subsecao{6.1. inside\_weaver\_directory e project\_path: Onde estamos}
A primeira das variáveis é |inside_weaver_directory|, que deve valer
|false| se o programa foi invocado de fora de um diretório de projeto
Weaver e |true| caso contrário.
Como definir se estamos em um diretório que pertence à um projeto
Weaver? Simples. São diretórios que contém dentro de si ou em um
diretório ancestral um diretório oculto
chamado \monoespaco{.weaver}. Caso encontremos este diretório oculto,
também podemos aproveitar e ajustar a variável |project_path| para
apontar para o local onde ele está. Se não o encontrarmos, estaremos
fora de um diretório Weaver e não precisamos mudar nenhum valor das
duas variáveis, pois elas deverão permanecer com o valor padrão
|NULL|.
Em suma, o que precisamos é de um loop com as seguintes
características:
\negrito{Invariantes}: A variável |complete_path| deve sempre
possuir o caminho completo do diretório \monoespaco{.weaver} se ele
existisse no diretório atual.
\negrito{Inicialização:} Inicializamos tanto o |complete_path|
para serem válidos de acordo com o diretório em que o programa é
invocado.
\negrito{Manutenção:} Em cada iteração do loop nós verificamos se
encontramos uma condição de finalização. Caso contrário, subimos
para o diretório pai do qual estamos, sempre atualizando as
variáveis para que o invariante continue válido.
\negrito{Finalização}: Interrompemos a execução do loop se uma das
três condições ocorrerem:
a) |complete_path == "/.weaver"|: Neste caso não podemos subir mais na
árvore de diretórios, pois estamos na raiz do sistema de arquivos. Não
encontramos um diretório \monoespaco{.weaver}. Isso significa que não
estamos dentro de um projeto Weaver.
b) |complete_path == "C:\\.weaver"|: A letra inicial pode não ser um
``C''. De qualquer forma, estamos na raíz do sistema dos arquivos e
não podemos subir mais como no caso acima. Com a diferença de estarmos
no Windows.
c) |complete_path == "./.weaver"| e tal arquivo existe e é diretório:
Neste caso encontramos um diretório \monoespaco{.weaver} e descobrimos
que estamos dentro de um projeto Weaver. Podemos então atualizar a
variável |project_path| para o diretório em que paramos.
O código de inicialização destas variáveis será então:
\iniciocodigo
@<Inicialização@>=
char *path = NULL, *complete_path = NULL;
#if !defined(_WIN32)
path = getcwd(NULL, 0); // Unix
#else
{ // Windows
DWORD bsize;
bsize = GetCurrentDirectory(0, NULL);
path = (char *) malloc(bsize);
GetCurrentDirectory(bsize, path);
}
#endif
if(path == NULL) W_ERROR();
complete_path = concatenate(path, "/.weaver", "");
free(path);
if(complete_path == NULL) W_ERROR();
@
\fimcodigo
Para obtermos o diretório atual, vamos precisar do cabeçalho:
\iniciocodigo
@<Cabeçalhos Incluídos no Programa Weaver@>=
#if !defined(_WIN32)
#include <unistd.h> // get_current_dir_name, getcwd, stat, chdir, getuid
#endif
@
\fimcodigo
Agora iniciamos um loop que terminará quando |complete_path| for igual
à \monoespaco{/.weaver} (chegamos no fim da árvore de diretórios e não
encontramos nada) ou quando realmente existir o
diretório \monoespaco{.weaver/} no diretório examinado. E no fim do
loop, sempre vamos para o diretório-pai do qual estamos:
\iniciocodigo
@<Inicialização@>+=
{
// Testa se chegamos ao fim:
while(strcmp(complete_path, "/.weaver") &&
strcmp(complete_path, "\\.weaver") &&
strcmp(complete_path + 1, ":\\.weaver")){
if(directory_exist(complete_path) == EXISTE_E_EH_DIRETORIO){
inside_weaver_directory = true;
complete_path[strlen(complete_path) - 7] = '\0'; // Apaga o '.weaver'
project_path = concatenate(complete_path, "");
if(project_path == NULL){ free(complete_path); W_ERROR(); }
break;
}
else{
path_up(complete_path);
#ifdef __OpenBSD__
{
size_t tmp_size = strlen(complete_path);
strlcat(complete_path, "/.weaver", tmp_size + 9);
}
#else
strcat(complete_path, "/.weaver");
#endif
}
}
free(complete_path);
}
@
\fimcodigo
Como alocamos memória para |project_path| armazenar o endereço do
projeto atual se estamos em um projeto Weaver, no final do programa
teremos que desalocar a memória:
\iniciocodigo
@<Finalização@>=
if(project_path != NULL) free(project_path);
@
\fimcodigo
\subsecao{6.2. weaver\_version\_major e weaver\_version\_minor: Versão do Programa}
Para descobrirmos a versão atual do Weaver que temos, basta consultar
o valor presente na macro |VERSION|. Então, obtemos o número de versão
maior e menor que estão separados por um ponto (se existirem). Note
que se não houver um ponto no nome da versão, então ela é uma versão
de testes. Mesmo neste caso o código abaixo vai funcionar, pois a
função |atoi| iria retornar 0 nas duas invocações por encontrar
respectivamente uma string sem dígito algum e um fim de string sem
conteúdo:
\iniciocodigo
@<Inicialização@>+=
{
char *p = VERSION;
while(*p != '.' && *p != '\0') p ++;
if(*p == '.') p ++;
weaver_version_major = atoi(VERSION);
weaver_version_minor = atoi(p);
}
@
\fimcodigo
\subsecao{6.3. project\_version\_major e project\_version\_minor: Versão do Projeto}
Se estamos dentro de um projeto Weaver, temos que inicializar
informação sobre qual versão do Weaver foi usada para atualizá-lo pela
última vez. Isso pode ser obtido lendo o arquivo
\italico{.weaver/version} localizado dentro do diretório Weaver. Se não
estamos em um diretório Weaver, não precisamos inicializar tais
valores. O número de versão maior e menor é separado por um ponto.
\iniciocodigo
@<Inicialização@>+=
if(inside_weaver_directory){
FILE *fp;
char *p, version[10];
char *file_path = concatenate(project_path, ".weaver/version", "");
if(file_path == NULL) W_ERROR();
fp = fopen(file_path, "r");
free(file_path);
if(fp == NULL) W_ERROR();
p = fgets(version, 10, fp);
if(p == NULL){ fclose(fp); W_ERROR(); }
while(*p != '.' && *p != '\0') p ++;
if(*p == '.') p ++;