SCons_experimental / src / engine / SCons / Tool / msvs.xml

  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
<?xml version="1.0" encoding="UTF-8"?>
<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
%scons;
<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
%builders-mod;
<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
%functions-mod;
<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
%tools-mod;
<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
%variables-mod;
]>

<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">

<tool name="msvs">
<summary>
<para>
Sets construction variables for Microsoft Visual Studio.
</para>
</summary>
<sets>
<item>MSVSPROJECTCOM</item>
<item>MSVSSOLUTIONCOM</item>
<item>MSVSSCONSCRIPT</item>
<item>MSVSSCONS</item>
<item>MSVSSCONSFLAGS</item>
<item>MSVSSCONSCOM</item>
<item>MSVSBUILDCOM</item>
<item>MSVSREBUILDCOM</item>
<item>MSVSCLEANCOM</item>
<item>MSVSENCODING</item>
</sets>
<uses>
</uses>
</tool>

<builder name ="MSVSProject">
<summary>
<para>
Builds a Microsoft Visual Studio project file,
and by default builds a solution file as well.
</para>

<para>
This builds a Visual Studio project file, based on the version of
Visual Studio that is configured (either the latest installed version,
or the version specified by
&cv-link-MSVS_VERSION;
in the Environment constructor).
For Visual Studio 6, it will generate a
<filename>.dsp</filename>
file.
For Visual Studio 7 (.NET) and later versions, it will generate a
<filename>.vcproj</filename>
file.
</para>

<para>
By default,
this also generates a solution file
for the specified project,
a
<filename>.dsw</filename>
file for Visual Studio 6
or a
<filename>.sln</filename>
file for Visual Studio 7 (.NET).
This behavior may be disabled by specifying
<literal>auto_build_solution=0</literal>
when you call
&b-MSVSProject;,
in which case you presumably want to
build the solution file(s)
by calling the
&b-MSVSSolution;
Builder (see below).
</para>

<para>
The &b-MSVSProject; builder
takes several lists of filenames
to be placed into the project file.
These are currently limited to
<literal>srcs</literal>,
<literal>incs</literal>,
<literal>localincs</literal>,
<literal>resources</literal>,
and
<literal>misc</literal>.
These are pretty self-explanatory, but it should be noted that these
lists are added to the &cv-link-SOURCES; construction variable as strings,
NOT as SCons File Nodes.  This is because they represent file
names to be added to the project file, not the source files used to
build the project file.
</para>

<para>
The above filename lists are all optional,
although at least one must be specified
for the resulting project file to be non-empty.
</para>

<para>
In addition to the above lists of values,
the following values may be specified:
</para>

<para>
<literal>target</literal>:
The name of the target
<filename>.dsp</filename>
or
<filename>.vcproj</filename>
file.
The correct
suffix for the version of Visual Studio must be used,
but the
&cv-link-MSVSPROJECTSUFFIX;
construction variable
will be defined to the correct value (see example below).
</para>

<para>
<literal>variant</literal>:
The name of this particular variant.
For Visual Studio 7 projects,
this can also be a list of variant names.
These are typically things like "Debug" or "Release", but really
can be anything you want.
For Visual Studio 7 projects,
they may also specify a target platform
separated from the variant name by a
<literal>|</literal>
(vertical pipe)
character:
<literal>Debug|Xbox</literal>.
The default target platform is Win32.
Multiple calls to
&b-MSVSProject;
with different variants are allowed;
all variants will be added to the project file with their appropriate
build targets and sources.
</para>

<para>
<literal>buildtarget</literal>:
An optional string, node, or list of strings or nodes
(one per build variant), to tell the Visual Studio debugger
what output target to use in what build variant.
The number of
<literal>buildtarget</literal>
entries must match the number of
<literal>variant</literal>
entries.
</para>

<para>
<literal>runfile</literal>:
The name of the file that Visual Studio 7 and later
will run and debug.
This appears as the value of the
<literal>Output</literal>
field in the resutling Visual Studio project file.
If this is not specified,
the default is the same as the specified
<literal>buildtarget</literal>
value.
</para>

<para>
Note that because &SCons; always executes its build commands
from the directory in which the &SConstruct; file is located,
if you generate a project file in a different directory
than the &SConstruct; directory,
users will not be able to double-click
on the file name in compilation error messages
displayed in the Visual Studio console output window.
This can be remedied by adding the
Visual C/C++
<literal>/FC</literal>
compiler option to the &cv-link-CCFLAGS;  variable
so that the compiler will print
the full path name of any
files that cause compilation errors.
</para>

<para>
Example usage:
</para>

<example_commands>
barsrcs = ['bar.cpp'],
barincs = ['bar.h'],
barlocalincs = ['StdAfx.h']
barresources = ['bar.rc','resource.h']
barmisc = ['bar_readme.txt']

dll = env.SharedLibrary(target = 'bar.dll',
                        source = barsrcs)

env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'],
                srcs = barsrcs,
                incs = barincs,
                localincs = barlocalincs,
                resources = barresources,
                misc = barmisc,
                buildtarget = dll,
                variant = 'Release')
</example_commands>
</summary>
</builder>

<builder name ="MSVSSolution">
<summary>
<para>
Builds a Microsoft Visual Studio solution file.
</para>

<para>
This builds a Visual Studio solution file,
based on the version of Visual Studio that is configured
(either the latest installed version,
or the version specified by
&cv-link-MSVS_VERSION;
in the construction environment).
For Visual Studio 6, it will generate a
<filename>.dsw</filename>
file.
For Visual Studio 7 (.NET), it will
generate a
<filename>.sln</filename>
file.
</para>

<para>
The following values must be specified:
</para>

<para>
<literal>target</literal>:
The name of the target .dsw or .sln file.  The correct
suffix for the version of Visual Studio must be used, but the value
&cv-link-MSVSSOLUTIONSUFFIX;
will be defined to the correct value (see example below).
</para>

<para>
<literal>variant</literal>:
The name of this particular variant, or a list of variant
names (the latter is only supported for MSVS 7 solutions). These are
typically things like "Debug" or "Release", but really can be anything
you want. For MSVS 7 they may also specify target platform, like this
"Debug|Xbox". Default platform is Win32.
</para>

<para>
<literal>projects</literal>:
A list of project file names, or Project nodes returned by calls to the
&b-MSVSProject;
Builder,
to be placed into the solution file.
It should be noted that these file names are NOT added to the $SOURCES
environment variable in form of files, but rather as strings.   This
is because they represent file names to be added to the solution file,
not the source files used to build the solution file.
</para>

<para>
Example Usage:
</para>

<example_commands>
env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'],
                 projects = ['bar' + env['MSVSPROJECTSUFFIX']],
                 variant = 'Release')
</example_commands>
</summary>
</builder>

<cvar name="MSVS">
<summary>
<para>
When the Microsoft Visual Studio tools are initialized, they set up
this dictionary with the following keys:
</para>

<para>
<envar>VERSION</envar>:
the version of MSVS being used (can be set via
&cv-link-MSVS_VERSION;)
</para>

<para>
<envar>VERSIONS</envar>:
the available versions of MSVS installed
</para>

<para>
<envar>VCINSTALLDIR</envar>:
installed directory of Visual C++
</para>

<para>
<envar>VSINSTALLDIR</envar>:
installed directory of Visual Studio
</para>

<para>
<envar>FRAMEWORKDIR</envar>:
installed directory of the .NET framework
</para>

<para>
<envar>FRAMEWORKVERSIONS</envar>:
list of installed versions of the .NET framework, sorted latest to oldest.
</para>

<para>
<envar>FRAMEWORKVERSION</envar>:
latest installed version of the .NET framework
</para>

<para>
<envar>FRAMEWORKSDKDIR</envar>:
installed location of the .NET SDK.
</para>

<para>
<envar>PLATFORMSDKDIR</envar>:
installed location of the Platform SDK.
</para>

<para>
<envar>PLATFORMSDK_MODULES</envar>:
dictionary of installed Platform SDK modules,
where the dictionary keys are keywords for the various modules, and
the values are 2-tuples where the first is the release date, and the
second is the version number.
</para>

<para>
If a value isn't set, it wasn't available in the registry.
</para>
</summary>
</cvar>

<cvar name="MSVS_ARCH">
<summary>
<para>
Sets the architecture for which the generated project(s) should build.
</para>

<para>
The default value is <literal>x86</literal>.
<literal>amd64</literal> is also supported
by &SCons; for some Visual Studio versions.
Trying to set &cv-MSVS_ARCH; to an architecture that's not
supported for a given Visual Studio version
will generate an error.
</para>
</summary>
</cvar>

<cvar name="MSVS_PROJECT_GUID">
<summary>
<para>
The string
placed in a generated Microsoft Visual Studio project file
as the value of the
<literal>ProjectGUID</literal>
attribute.
There is no default value. If not defined, a new GUID is generated.
</para>
</summary>
</cvar>

<cvar name="MSVS_SCC_AUX_PATH">
<summary>
<para>
The path name
placed in a generated Microsoft Visual Studio project file
as the value of the
<literal>SccAuxPath</literal>
attribute
if the
<envar>MSVS_SCC_PROVIDER</envar>
construction variable is also set.
There is no default value.
</para>
</summary>
</cvar>

<cvar name="MSVS_SCC_CONNECTION_ROOT">
<summary>
<para>
The root path of projects in your SCC workspace, i.e the path under which
all project and solution files will be generated. It is used as a
reference path from which the relative paths of the generated
Microsoft Visual Studio project and solution files are computed.
The relative project file path is placed as the value of the
<literal>SccLocalPath</literal>
attribute
of the project file
and as the values of the
<literal>SccProjectFilePathRelativizedFromConnection[i]</literal>
(where [i] ranges from 0 to the number of projects in the solution)
attributes of the
<literal>GlobalSection(SourceCodeControl)</literal>
section of the Microsoft Visual Studio solution file.
Similarly the relative solution file path is placed as the values of the
<literal>SccLocalPath[i]</literal>
(where [i] ranges from 0 to the number of projects in the solution)
attributes of the
<literal>GlobalSection(SourceCodeControl)</literal>
section of the Microsoft Visual Studio solution file.
This is used only
if the
<envar>MSVS_SCC_PROVIDER</envar>
construction variable is also set.
The default value is the current working directory.
</para>
</summary>
</cvar>

<cvar name="MSVS_SCC_PROJECT_NAME">
<summary>
<para>
The project name
placed in a generated Microsoft Visual Studio project file
as the value of the
<literal>SccProjectName</literal>
attribute
if the
<envar>MSVS_SCC_PROVIDER</envar>
construction variable is also set.
In this case the string is also placed in the
<literal>SccProjectName0</literal>
attribute of the
<literal>GlobalSection(SourceCodeControl)</literal>
section of the Microsoft Visual Studio solution file.
There is no default value.
</para>
</summary>
</cvar>

<cvar name="MSVS_SCC_PROVIDER">
<summary>
<para>
The string
placed in a generated Microsoft Visual Studio project file
as the value of the
<literal>SccProvider</literal>
attribute.
The string is also placed in the
<literal>SccProvider0</literal>
attribute of the
<literal>GlobalSection(SourceCodeControl)</literal>
section of the Microsoft Visual Studio solution file.
There is no default value.
</para>
</summary>
</cvar>

<cvar name="MSVS_VERSION">
<summary>
<para>
Sets the preferred version of Microsoft Visual Studio to use.
</para>

<para>
If &cv-MSVS_VERSION; is not set,
&SCons; will (by default) select the latest version
of Visual Studio installed on your system.
So, if you have version 6 and version 7 (MSVS .NET) installed,
it will prefer version 7.
You can override this by
specifying the
<envar>MSVS_VERSION</envar>
variable in the Environment initialization, setting it to the
appropriate version ('6.0' or '7.0', for example).
If the specified version isn't installed,
tool initialization will fail.
</para>

<para>
This is obsolete: use &cv-MSVC_VERSION; instead. If &cv-MSVS_VERSION; is set and
&cv-MSVC_VERSION; is not, &cv-MSVC_VERSION; will be set automatically to &cv-MSVS_VERSION;.
If both are set to different values, scons will raise an error.
</para>
</summary>
</cvar>

<cvar name="MSVSBUILDCOM">
<summary>
<para>
The build command line placed in
a generated Microsoft Visual Studio project file.
The default is to have Visual Studio invoke SCons with any specified
build targets.
</para>
</summary>
</cvar>

<cvar name="MSVSCLEANCOM">
<summary>
<para>
The clean command line placed in
a generated Microsoft Visual Studio project file.
The default is to have Visual Studio invoke SCons with the -c option
to remove any specified targets.
</para>
</summary>
</cvar>

<cvar name="MSVSENCODING">
<summary>
<para>
The encoding string placed in
a generated Microsoft Visual Studio project file.
The default is encoding
<literal>Windows-1252</literal>.
</para>
</summary>
</cvar>

<cvar name="MSVSPROJECTCOM">
<summary>
<para>
The action used to generate Microsoft Visual Studio project files.
</para>
</summary>
</cvar>

<cvar name="MSVSPROJECTSUFFIX">
<summary>
<para>
The suffix used for Microsoft Visual Studio project (DSP) files.
The default value is
<filename>.vcproj</filename>
when using Visual Studio version 7.x (.NET)
or later version,
and
<filename>.dsp</filename>
when using earlier versions of Visual Studio.
</para>
</summary>
</cvar>

<cvar name="MSVSREBUILDCOM">
<summary>
<para>
The rebuild command line placed in
a generated Microsoft Visual Studio project file.
The default is to have Visual Studio invoke SCons with any specified
rebuild targets.
</para>
</summary>
</cvar>

<cvar name="MSVSSCONS">
<summary>
<para>
The SCons used in generated Microsoft Visual Studio project files.
The default is the version of SCons being
used to generate the project file.
</para>
</summary>
</cvar>

<cvar name="MSVSSCONSFLAGS">
<summary>
<para>
The SCons flags used in generated Microsoft Visual Studio
project files.
</para>
</summary>
</cvar>

<cvar name="MSVSSCONSCOM">
<summary>
<para>
The default SCons command used in generated Microsoft Visual Studio
project files.
</para>
</summary>
</cvar>

<cvar name="MSVSSCONSCRIPT">
<summary>
<para>
The sconscript file
(that is,
&SConstruct;
or
&SConscript;
file)
that will be invoked by Visual Studio
project files
(through the
&cv-link-MSVSSCONSCOM;
variable).
The default is the same sconscript file
that contains the call to
&b-MSVSProject;
to build the project file.
</para>
</summary>
</cvar>

<cvar name="MSVSSOLUTIONCOM">
<summary>
<para>
The action used to generate Microsoft Visual Studio solution files.
</para>
</summary>
</cvar>

<cvar name="MSVSSOLUTIONSUFFIX">
<summary>
<para>
The suffix used for Microsoft Visual Studio solution (DSW) files.
The default value is
<filename>.sln</filename>
when using Visual Studio version 7.x (.NET),
and
<filename>.dsw</filename>
when using earlier versions of Visual Studio.
</para>
</summary>
</cvar>

<cvar name="SCONS_HOME">
<summary>
<para>
The (optional) path to the SCons library directory,
initialized from the external environment.
If set, this is used to construct a shorter and more
efficient search path in the
&cv-link-MSVSSCONS;
command line executed
from Microsoft Visual Studio project files.
</para>
</summary>
</cvar>

</sconsdoc>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.