[CMD]
[reactos.git] / reactos / base / shell / cmd / readme2.txt
1 General Overview of How THings Work
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3 First it comes into _main in cmd.c(1811). The command line params are taking in and if it is unicode it uses CommandLineToArgvW.
4 This can cause a problem on older machines and that is why we have our own custom _CommandLineToArgvW to help this along.
5 We pull in the launch directory as the inital dir and set that in _tchdir. We make a handle to the default console out using CreateFile.
6
7 Then we call Initialize(). Here we need to load ntdll.dll if it isnt loaded(windows 9x machines).
8 We also setup some global vars like default io handles and nErrorLevel and set %prompt% to $P$G.
9 This is where all command lines switches given to cmd on startup are done.
10
11 From here main calls ProcessInput(). This is where cmd loops for getting input and doing the commands.
12 First it checks to see if there is a batch file(note: there is a global struct "bc" which is NULL when not processing a batch file)
13 and if there is it will pull a new line from that file. If not, thne it will wait for input.
14 Currently there is some stuff for set /a in there, which might stay there or see if we can find a better spot.
15
16 Once there is input taken in from the command line it is sent into ParseCommandLine().
17 In here we fist check for aliases and convert if need be.
18 Then we look for redirections using GetRedirection() which will remove any redirection symbols.
19 and pass back info about where to redirect.
20 from this info it will do some switching around with the handles for where things go and send them as need be.
21 personally i dont like this code and i tried to chnage it before but failed.
22 it is confusing to me and i dont understand why a lot of it is there but apparently it is needed.
23
24 It sends the new string without any redirection info into DoCommand(). In this function we just look to see what should be done.
25 There is one of 2 things that could happen.
26 1) we fnd the matching command and send it off to that commands little section.
27 2) we dont find it so we send it to Execute() and see if it is a file that we can do something.
28
29 Execute will try to launch the file using createprocess and falls back on shellexecute.
30 It calls a function called SearchForExecuteable() to find the full path name and looks in all the correct locations like PATH,
31 curreent folder, windows folder. If it cant find it, just fails and prints out a message.
32
33 Some useful functions that are used a lot:
34
35 split() - splits a string into an array of string on spaces that arent inside quotes. which you need to call freep() on later t clean up.
36 //Split it´s used to take the Arguments from Command Line,it´s the best option for almost all the cases.
37 //If the Command has special needs as Dir, it´s better to make a Parser INSIDE that Command(as DIR has)
38 //Dont get mad(as i did): Split() can be find in Misc.c file.Really easy to follow.
39 //Also remember split() recive the Command Line,but the Command Line WITHOUT command name.
40
41 splitspace()-split a string into an array of string using spaces as splitters.which you need to call freep() on later to clean up.
42 //This is the son of split() for commands that manage in the same way "/" and "\" when are INSIDE the paths.
43 //i.e move works in the same way with: move C:\this/is\a/mess C:\i/know,and with move C:/this/is/a/mess C:/i/know
44 //Other commands DOESNT.
45 //You can find also in misc.c
46
47 IsValidPathName(), IsExistingFile(), IsExistingDirectory() - all do what you would expect.
48 PagePrompt() - ask them to hit a key to continue
49 FilePromptYN[A]() - ask them a yes or no question