Jump to content

  • Log In with Google      Sign In   
  • Create Account


User versus System include, quotes and brackets etc.


Old topic!
Guest, the last post of this topic is over 60 days old and at this point you may not reply in this topic. If you wish to continue this conversation start a new topic.

  • You cannot reply to this topic
5 replies to this topic

#1 AllEightUp   Moderators   -  Reputation: 4124

Like
1Likes
Like

Posted 29 March 2013 - 12:12 PM

In the process of writing a series of articles I realized that I stopped using the preprocessor differentiation of user and system paths in the "technically" correct manner.  Part of this is on purpose but part is basically because I don't find the differentiation particularly useful anymore.  Anyway, the question is how you use includes and how much you use the different path rules and why?

 

 

With Gcc/Clang you have -I and -iquote options to control the different paths between quoted and bracketed.  As far as I can remember, Cl (Visual Studio) supplies no '-iquote' style variation so the only difference is the search of the local or relative directories between brackets and quotes.

 

My thinking is that, obviously there is a notable difference and I do use it correctly in most cases I believe.  '#include "item"' looks in the current directory first, so unless the current code location has been added to the search path, this is how you get at local headers.  For almost every other usage though, I rely on controlling the include path order and using naming/nesting habits which avoid conflicts.  Someone ran into conflicts recently with 'math.h' which in conjunction with proofing the code made me think about this problem and how I had been writing code to avoid it.

 

Other than local, or relative to the current directory, searches, what other reasons do folks use the quoted versions for?  I realized my example code needed a fix since my reasons for using quotes and brackets didn't match what I put in the example code.  Oops.  But as stated, it got me to thinking about this and how others deal with it.  I might even turn it into a little article for fun. smile.png


Edited by AllEightUp, 29 March 2013 - 12:13 PM.


Sponsor:

#2 Shannon Barber   Moderators   -  Reputation: 1356

Like
2Likes
Like

Posted 29 March 2013 - 03:24 PM

Technically there doesn't have to be a stdio nor stdlib file. The compiler is allowed to supply them internally (or any which way the implementer desires).

 

So

#include "stdio"

is pedantically incorrect and unportable code as it requires the file "stdio" to exist.

#include <stdio>

is how the compiler is told find-the-system-header called 'stdio'.

 

In practice every C/C++ compiler I know of uses files for the standard headers so it ends up not mattering much.

 

Not every compiler will even honor the system folders vs current folder rule. Many require you to give them an explicit list of include directories and they always search them in order.


Edited by Shannon Barber, 29 March 2013 - 03:25 PM.

- The trade-off between price and quality does not exist in Japan. Rather, the idea that high quality brings on cost reduction is widely accepted.-- Tajima & Matsubara

#3 AllEightUp   Moderators   -  Reputation: 4124

Like
0Likes
Like

Posted 29 March 2013 - 04:39 PM

Technically there doesn't have to be a stdio nor stdlib file. The compiler is allowed to supply them internally (or any which way the implementer desires).

 

So

#include "stdio"

is pedantically incorrect and unportable code as it requires the file "stdio" to exist.

#include <stdio>

is how the compiler is told find-the-system-header called 'stdio'.

Yeah, I've seen a couple odd compilers for embedded systems which do some of these things.  Of course this was "way" back with C only.  I had hoped such things went out of style in the last 15 or so years.  Of course, you never know so yup, this is one I try to do correctly at all times..

 

In practice every C/C++ compiler I know of uses files for the standard headers so it ends up not mattering much.

 

Not every compiler will even honor the system folders vs current folder rule. Many require you to give them an explicit list of include directories and they always search them in order.

 

I'd be curious if you know any current semi-mainstream compilers with this behavior?  I've seen goofy ass behavior on and off but usually in really limited special purpose environments.  Are there are any in use, fairly mainstream compilers, doing this that you've seen?  I.e. places you might want to build a game would be my primary interest of course.



#4 Josh Vega   Crossbones+   -  Reputation: 1150

Like
0Likes
Like

Posted 29 March 2013 - 11:41 PM

My rule is usually to use brackets for STL, Standard Library, OS APIs (e.g. Win32), and External Dependencies (outside my project hierarchy) and quotes for Internal Dependencies (in a folder that holds all 3rd-party code and libraries in my project hierarchy) and project headers.


Some favourite quotes:
Spoiler

#5 Servant of the Lord   Crossbones+   -  Reputation: 17269

Like
2Likes
Like

Posted 30 March 2013 - 12:57 AM

I use <file> for standard and 3rd party libraries, and "file" for the project's own code.


Edited by Servant of the Lord, 30 March 2013 - 12:58 AM.

It's perfectly fine to abbreviate my username to 'Servant' rather than copy+pasting it all the time.

[Fly with me on Twitter] [Google+] [My broken website]

All glory be to the Man at the right hand... On David's throne the King will reign, and the Government will rest upon His shoulders. All the earth will see the salvation of God.                                                                                                                                                       [Need free cloud storage? I personally like DropBox]

Of Stranger Flames - [indie turn-based rpg set in a para-historical French colony] | Indie RPG development journal


#6 Endurion   Crossbones+   -  Reputation: 3336

Like
0Likes
Like

Posted 30 March 2013 - 01:04 PM

Same as SotL, <> for non-project (e.g. system, external libs, my code base), and "" for project code.


Fruny: Ftagn! Ia! Ia! std::time_put_byname! Mglui naflftagn std::codecvt eY'ha-nthlei!,char,mbstate_t>




Old topic!
Guest, the last post of this topic is over 60 days old and at this point you may not reply in this topic. If you wish to continue this conversation start a new topic.



PARTNERS