What is the difference between #include <filename> and #include "filename"?
Asked Answered
D

30

3094

What is the difference between using angle brackets and quotes in an include directive?

  • #include <filename>
  • #include "filename"
Drucilladrucy answered 22/8, 2008 at 1:40 Comment(3)
gcc.gnu.org/onlinedocs/gcc-2.95.3/cpp_1.html#SEC6Thayer
Where Does GCC Look to Find its Header FilesRing
For the behavior of Visual Studio, please check: learn.microsoft.com/en-us/cpp/preprocessor/…Mortenson
D
1884

What differs is the locations in which the preprocessor searches for the file to be included.

  • #include <filename>   The preprocessor searches in an implementation-defined manner, normally in directories pre-designated by the compiler/IDE. This method is normally used to include header files for the C standard library and other header files associated with the target platform.

  • #include "filename"   The preprocessor also searches in an implementation-defined manner, but one that is normally used to include programmer-defined header files and typically includes same directory as the file containing the directive (unless an absolute path is given).

For GCC, a more complete description is available in the GCC documentation on search paths.

Drucilladrucy answered 22/8, 2008 at 1:40 Comment(9)
The statement: "the preprocessor searches in the same directory..." may be true in practice but the standard states that the named source file is "searched for in an implementation-defined manner". See answer from piCookie.Bim
While your answer may appear to be "true", because this is how many implementations work by convention, you should take a close look at aib's and piCookie's answers. They both point out (backed by the wording of the C standard) that the real distinction is inclusion of a "header" versus inclusion of a "source file" (and no, this doesn't mean ".h" vs. ".c"). "Source file" in this context can be (and usually is, and almost always should be) a ".h" file. A header does not necessarily need to be a file (a compiler could e.g. include a header that is statically coded, not in a file).Shatterproof
"... the preprocessor searches in the same directory as the file being compiled for the file to be included." This statement is not completely correct. I was interested in this question because I was curious what the actual answer is, but I know this is not true because at least with gcc when you specify an additional include path with -I that will search for files specified with #include "filename.h"Aztec
Those who don't like the answer, please, give one practical example, where it is wrong.Splint
Sure enough, I recently mixed these syntaxes when including headers from 'the same' library and ended up with redefinition errors. If I understand correctly, #include <...> used the package installed on the system and #include "..." used the nearby repository version. I might have those backwards. Either way, the include guard in the packaged header is prefixed with an underscore. (It could be a convention for packages or maybe a way to deliberately prevent mixing the two, although version qualifiers would make more sense to me.)Pedate
Why do some windows users #include pch.h file in quotes? It's not somewhat "programmers-defined" fileGaekwar
In effect it allows the included content to be "hotfixed" during compilation to "override" the normal include path. It prevents mangling someone else's original (from a github library, say) source. This is very common for Arduino libs and even cores.Borne
"One practical example where it's wrong" is irrelevant. Standards exist for a reason. The guideline (in the standard) is to use <> for headers included with the implementation, "" for everything else. But it's made clear that this is a guideline only, the search paths for both cases are implementation defined other than the fact "" will fall back to <> if it can't be found.Bailly
If you add your own project root to your Include Directories, you can include your project's local header files with <angleBracketInclude.h>Dis
P
834

The only way to know is to read your implementation's documentation.

In the C standard, section 6.10.2, paragraphs 2 to 4 state:

  • A preprocessing directive of the form

    #include <h-char-sequence> new-line
    

    searches a sequence of implementation-defined places for a header identified uniquely by the specified sequence between the < and > delimiters, and causes the replacement of that directive by the entire contents of the header. How the places are specified or the header identified is implementation-defined.

  • A preprocessing directive of the form

    #include "q-char-sequence" new-line
    

    causes the replacement of that directive by the entire contents of the source file identified by the specified sequence between the " delimiters. The named source file is searched for in an implementation-defined manner. If this search is not supported, or if the search fails, the directive is reprocessed as if it read

    #include <h-char-sequence> new-line
    

    with the identical contained sequence (including > characters, if any) from the original directive.

  • A preprocessing directive of the form

    #include pp-tokens new-line
    

    (that does not match one of the two previous forms) is permitted. The preprocessing tokens after include in the directive are processed just as in normal text. (Each identifier currently defined as a macro name is replaced by its replacement list of preprocessing tokens.) The directive resulting after all replacements shall match one of the two previous forms. The method by which a sequence of preprocessing tokens between a < and a > preprocessing token pair or a pair of " characters is combined into a single header name preprocessing token is implementation-defined.

Definitions:

  • h-char: any member of the source character set except the new-line character and >

  • q-char: any member of the source character set except the new-line character and "

Pembroke answered 16/9, 2008 at 21:6 Comment(19)
Relevant: implementation in g++ and in visual c++Farrago
@Pembroke both <filename> and "filename" search for implementation-defined places. So what is the difference ?Alpenglow
@entropy: In a forum like this, it is not possible to answer your question. An answer that would be correct for one particular compiler could be entirely wrong for another. Each particular implementation / compiler should be obligated to spell out the difference, and that is the only reliable way to know. Several other answers have given examples, and perhaps your implementation is mentioned in one of those.Pembroke
@Pembroke but you could say that angle brackets are inspecting the INCLUDE_PATH, where "" doesn't. so angle brackets are introducing a search path but aren't cwd at all. actually there is no difference, if you reduce it to the point, that <> only searches on the standard include path.Secular
@Stefan, I'm just quoting the standard which does not say anything about INCLUDE_PATH. Your implementation may do that, and mine may not. The original question was generically C and not specifically gcc (which I don't think uses INCLUDE_PATH) or Microsoft C (which I think does) or any other, so it can not be answered generically but instead each implementation's documentation must be referenced.Pembroke
@Pembroke no. INCLUDE_PATH was more meant to be as a variable containing the standard paths for the compiler, not a vendor specific implementation detail.Secular
As with all of these situations, concrete examples (especially of common scenarios) are greatly useful and equally appreciated. Needlessly obtuse generic answers don't have as much practical use.Towering
I don't exactly know how this is in C, bit if I read the standard quotation above, the sequence between < and > does not necessarily have to be a file name. Anything that uniquely defines a header will do. In C++, this means that <algorithm> does not necessarily map to a file called "algorithm" or "algorithm.h". How this file is actually named, or if the header is even a file in the file system is implementation defined. But the q-char-sequence in the second version does indeed contain a real file name.Indeed
@Alpenglow the standard allows for two alternative search mechanisms. If an alternative search mechanism (for include "") is not implemented, include "" functions as include <>. However, this quote from the standards definitely should have a summary -- no one has to waste time figuring out what it implies.Negress
"Here's how the C standard can be verbose and not answer your question"Dashboard
"The only way to know is to read your implementation's documentation." Or by asking someone on Stack Overflow. I appreciate that you went for the "teaching moment" but I'm afraid that attitude is quickly becoming outdated.Jeramyjerba
"both <filename> and "filename" search for implementation-defined places". How is this answer practically useful?Forcemeat
@MaximEgorushkin see Alexander Malakhov's comment for links that describe the implementation for gcc and visual C++. There should be similar documentation for any other commercial compiler. IMO, Alexander's comment should be part of the answer.Ahn
People come here to have things explained to them in a manner which they can understand. Simply pointing to cryptic documentation is not helpful. That poor documentation is exactly why so many of us are at this exact question.Epiboly
@DaveVoyles-MSFT this is the only correct answer, because the question didn't specify which implementation, just "the C and C++ programming languages". How some implementations handle #include has already been pointed out in the comments, which is where they belong because they wouldn't really answer the question.Mccarron
If the answer is to be of any use, it should mention the intended purpose and common use of those directives, not only quote the standard, which tells how things are defined, but does not tell why. The answer should include the fact <> is used to include standard library headers, while "" is used to include project local includes.Gough
The purpose of quoting the standard is to show that there is no answer provided by the standard, as the difference, if any, between these two forms is entirely up to the implementation, Which is why quoting the standard was predicated by suggesting you read your implementation's relevant documentation because OP didn't state what their implementation was. To put it bluntly: There is no standard answer, so you MUST consult your implementation's relevant documentation to find out for your particular case.Thanatos
@Gough - you have to remember that when C was first standardised, it was already 15+ years old, and different implementations did things differently... these differences were documented as "implementation defined"Eugeneeugenia
It would be better to put the definitions on top.Underthrust
R
359

The sequence of characters between < and > uniquely refer to a header, which isn't necessarily a file. Implementations are pretty much free to use the character sequence as they wish. (Mostly, however, just treat it as a file name and do a search in the include path, as the other posts state.)

If the #include "file" form is used, the implementation first looks for a file of the given name, if supported. If not (supported), or if the search fails, the implementation behaves as though the other (#include <file>) form was used.

Also, a third form exists and is used when the #include directive doesn't match either of the forms above. In this form, some basic preprocessing (such as macro expansion) is done on the "operands" of the #include directive, and the result is expected to match one of the two other forms.

Rhiana answered 8/9, 2008 at 17:43 Comment(9)
+1, this is probably the most concise and correct answer here. According to the standard (which piCookie quotes from in his answer), the only real difference is "header" versus "source file". The search mechanism is implementation-defined either way. Using double quotes means that you intend to include a "source file", while angle brackets mean you intend to include a "header" which, as you say, may not be a file at all.Shatterproof
I know I'm asking this a long time after you posted the answer, but @aib, what do you mean by "uniquely refer to a header, which isn't necessarily a file"? Even a header-files are files!Mariellamarielle
See Dan Moulding's comment to quest49's answer; standard headers don't have to be in file form, they can be built-in.Rhiana
I've been reading this "standard headers don't have to be in file form" for a decade. Care to provide a real-world example?Forcemeat
@Maxim Yegorushkin: I can't think of any existing real-world examples either; however, no complete C11 compiler can exist for MS-DOS unless headers don't have to be files. This is because some of the C11 header names are not compatible with the "8.3" MS-DOS file name limitation.Shatterproof
Headers are not necessarily files. If you write #include <stdlib.h>, the header could be directly built into the compiler.Dilative
@DanMoulding: The MS-DOS based compilers I've seen would almost invariably interpret #include "thisIsAVeryLongName.and.I.Love.Dots.h" as a request to read a file THISISAV.AND`; one would give a warning that the name in the directive didn't match the file; the rest I've seen would simply ignore that. Would any of the headers required for C11 not work under such a model, e.g. because two distinct names have a shared 8-letter prefix?Ium
@MaximEgorushkin: The VAX/VMS C compiler kept all the C runtime library headers in a single textual library file (similar to a unix archive), and used the string between the < and > as the key to index into the library.Fabrikoid
a header, which isn't necessarily a file -- reminds me of URLs (mostly files in the beginning and these days everything you can think of)Marlysmarmaduke
O
140

Some good answers here make references to the C standard but forgot the POSIX standard, especially the specific behavior of the c99 (e.g. C compiler) command.

According to The Open Group Base Specifications Issue 7,

-I directory

Change the algorithm for searching for headers whose names are not absolute pathnames to look in the directory named by the directory pathname before looking in the usual places. Thus, headers whose names are enclosed in double-quotes ( "" ) shall be searched for first in the directory of the file with the #include line, then in directories named in -I options, and last in the usual places. For headers whose names are enclosed in angle brackets ( "<>" ), the header shall be searched for only in directories named in -I options and then in the usual places. Directories named in -I options shall be searched in the order specified. Implementations shall support at least ten instances of this option in a single c99 command invocation.

So, in a POSIX compliant environment, with a POSIX compliant C compiler, #include "file.h" is likely going to search for ./file.h first, where . is the directory where is the file with the #include statement, while #include <file.h>, is likely going to search for /usr/include/file.h first, where /usr/include is your system defined usual places for headers (it's seems not defined by POSIX).

Occur answered 20/7, 2012 at 9:29 Comment(3)
What is exact source of the text? Is it from normative part of IEEE Std 1003.1, 2013?Hove
@osgx: that wording (or something extremely similar) is found in the POSIX specification for c99 — which is the POSIX name for the C compiler. (The POSIX 2008 standard could hardly refer to C11; the 2013 update to POSIX 2008 did not change the C standard that it referred to.)Keratose
This was my first thought too. The manpage for gcc includes this as do others. There's also a similar thing for libraries - -L.Projectionist
C
76

The exact behavior of the preprocessor varies between compilers. The following answer applies for GCC and several other compilers.

#include <file.h> tells the compiler to search for the header in its "includes" directory, e.g. for MinGW the compiler would search for file.h in C:\MinGW\include\ or wherever your compiler is installed.

#include "file" tells the compiler to search the current directory (i.e. the directory in which the source file resides) for file.

You can use the -I flag for GCC to tell it that, when it encounters an include with angled brackets, it should also search for headers in the directory after -I. GCC will treat the directory after the flag as if it were the includes directory.

For instance, if you have a file called myheader.h in your own directory, you could say #include <myheader.h> if you called GCC with the flag -I . (indicating that it should search for includes in the current directory.)

Without the -I flag, you will have to use #include "myheader.h" to include the file, or move myheader.h to the include directory of your compiler.

Cotsen answered 11/3, 2018 at 23:6 Comment(2)
Crazy that so few people (including myself) understand something so basic to developing in C/C++. The tyranny of poorly documented conventions.Salter
Would you share any reference?Disorder
S
60

GCC documentation says the following about the difference between the two:

Both user and system header files are included using the preprocessing directive ‘#include’. It has two variants:

#include <file>

This variant is used for system header files. It searches for a file named file in a standard list of system directories. You can prepend directories to this list with the -I option (see Invocation).

#include "file"

This variant is used for header files of your own program. It searches for a file named file first in the directory containing the current file, then in the quote directories and then the same directories used for <file>. You can prepend directories to the list of quote directories with the -iquote option. The argument of ‘#include’, whether delimited with quote marks or angle brackets, behaves like a string constant in that comments are not recognized, and macro names are not expanded. Thus, #include <x/*y> specifies inclusion of a system header file named x/*y.

However, if backslashes occur within file, they are considered ordinary text characters, not escape characters. None of the character escape sequences appropriate to string constants in C are processed. Thus,#include "x\n\\y"specifies a filename containing three backslashes. (Some systems interpret ‘\’ as a pathname separator. All of these also interpret ‘/’ the same way. It is most portable to use only ‘/’.)

It is an error if there is anything (other than comments) on the line after the file name.

Sivia answered 14/1, 2017 at 4:52 Comment(6)
What is a "quote directory"?Hautegaronne
@JackM • there are 3 locations: the #include-ing file's current directory, the quote directories (the paths to check for the #include "foo.h" style includes), and the system directories (the paths to check for the #include <bar.h> style includes).Salon
What does "system" mean in the phrase "system header file"? I find that computer scientists throw around this word "system" a lot and I often can't tell if it means "operating system", "computer system", or something else.Eggnog
This is the best answer. This topic can be discussed ad infinitum for years and decades, but the clear compiler trend is that <> is for system headers and " " is for local directory and project headers. I use <> for system headers and " " for everything else. That way it's clear in code whether a header is a system header. Plus, this way, if you move local project headers to different directory as you change code, you don't need to change " " to <> and vice versa. (PS: This is also the ReSharper C++ methodology with includes headers automatically for you).Canaille
I agree this is the best answer. For clarification, to me a system file is anything you did not write, and are referencing, of course your compiler includes, but beyond that any other installed packages. And a program file you wrote. Using Google protobufs, a system file would be <google/protobuf/type_pb.h>, and a program file would be your protobuf "mydir/my_pb.h".Oribella
I also agree this is a very good answer but only if your world is limited to using gcc and similarly-behaving environments :-) The question asked about C, which is much wider in scope than gcc. This answer would be much better if it mentioned that limitation. As it stands now, it could be read as implying these rules are sacrosanct across all implementations.Bailly
E
52

It does:

"mypath/myfile" is short for ./mypath/myfile

with . being either the directory of the file where the #include is contained in, and/or the current working directory of the compiler, and/or the default_include_paths

and

<mypath/myfile> is short for <defaultincludepaths>/mypath/myfile

If ./ is in <default_include_paths>, then it doesn't make a difference.

If mypath/myfile is in another include directory, the behavior is undefined.

Emrich answered 8/2, 2011 at 11:45 Comment(4)
No, #include "mypath/myfile" is not equivalent to #include "./mypath/myfile". As piCookie's answer says, double quotes tell the compiler to search in an implementation-defined manner -- which includes searching in the places specified for #include <...>. (Actually, it probably is equivalent, but only because, for example, /usr/include/mypath/myfile can be referred to as /usr/include/./mypath/myfile -- at least on Unix-like systems.)Imbibition
@Keith Thompson: That's right, I was thinking of my Linux box. Evidently it could be different. Though in practice, Windows as non-Posix operating system also does interprete / as path separator, and ./ also exists.Emrich
the -L dirpath option then adds dirpath to the defaultincludepaths, as opposed to giving another meaning to the . (as referred to above). This has the expected consequence that both #include "..." and #include <...> search in dirpathYaron
I think this answer is incorrect, since it implies that headers included with double quotes are always looked for in the current working directory. The search mechanism is way more detailed; this answer is incomplete. I'm not adding this comment to complain or whine, but because the system asks me to add a comment to explain why I voted this answer down.Able
V
47

The <file> include tells the preprocessor to search in -I directories and in predefined directories first, then in the .c file's directory. The "file" include tells the preprocessor to search the source file's directory first, and then revert to -I and predefined. All destinations are searched anyway, only the order of search is different.

The 2011 standard mostly discusses the include files in "16.2 Source file inclusion".

2 A preprocessing directive of the form

# include <h-char-sequence> new-line

searches a sequence of implementation-defined places for a header identified uniquely by the specified sequence between the < and > delimiters, and causes the replacement of that directive by the entire contents of the header. How the places are specified or the header identified is implementation-defined.

3 A preprocessing directive of the form

# include "q-char-sequence" new-line

causes the replacement of that directive by the entire contents of the source file identified by the specified sequence between the " delimiters. The named source file is searched for in an implementation-defined manner. If this search is not supported, or if the search fails, the directive is reprocessed as if it read

# include <h-char-sequence> new-line

with the identical contained sequence (including > characters, if any) from the original directive.

Note that "xxx" form degrades to <xxx> form if the file is not found. The rest is implementation-defined.

Vala answered 3/9, 2008 at 12:17 Comment(4)
Could you provide a reference to where in the C standard this -I business is specified?Butterscotch
I see no reference to -I.Butterscotch
That's "implementation-defined" part.Vala
"All destinations are searched anyway, only the order of search is different." How can it then be that if I try to compile my program with mingw that if I include with < > it cannot find my header file, but with " " it does find it.Creatural
H
26

By the standard - yes, they are different:

  • A preprocessing directive of the form

    #include <h-char-sequence> new-line
    

    searches a sequence of implementation-defined places for a header identified uniquely by the specified sequence between the < and > delimiters, and causes the replacement of that directive by the entire contents of the header. How the places are specified or the header identified is implementation-defined.

  • A preprocessing directive of the form

    #include "q-char-sequence" new-line
    

    causes the replacement of that directive by the entire contents of the source file identified by the specified sequence between the " delimiters. The named source file is searched for in an implementation-defined manner. If this search is not supported, or if the search fails, the directive is reprocessed as if it read

    #include <h-char-sequence> new-line
    

    with the identical contained sequence (including > characters, if any) from the original directive.

  • A preprocessing directive of the form

    #include pp-tokens new-line
    

    (that does not match one of the two previous forms) is permitted. The preprocessing tokens after include in the directive are processed just as in normal text. (Each identifier currently defined as a macro name is replaced by its replacement list of preprocessing tokens.) The directive resulting after all replacements shall match one of the two previous forms. The method by which a sequence of preprocessing tokens between a < and a > preprocessing token pair or a pair of " characters is combined into a single header name preprocessing token is implementation-defined.

Definitions:

  • h-char: any member of the source character set except the new-line character and >

  • q-char: any member of the source character set except the new-line character and "

Note that the standard does not tell any relation between the implementation-defined manners. The first form searches in one implementation-defined way, and the other in a (possibly other) implementation-defined way. The standard also specifies that certain include files shall be present (for example, <stdio.h>).

Formally you'd have to read the manual for your compiler, however normally (by tradition) the #include "..." form searches the directory of the file in which the #include was found first, and then the directories that the #include <...> form searches (the include path, eg system headers).

Hartmunn answered 18/8, 2015 at 6:21 Comment(3)
This is mostly just the same text as piCookie's answer from seven years earlier.Lienlienhard
@KyleStrand That's because the same text is a quote of the relevant section in the standard - that text should be identical. The actual answer is not the same text and is somewhat different - while I also recognize that it will be written in the documentation for the implementation I also note that there's also a traditional way these are interpreted (that most or all compilers I used respects).Hartmunn
IMO this is the best answer here, because it covers both what the standard says and what most compilers actually do.Lamothe
N
22

At least for GCC version <= 3.0, the angle-bracket form does not generate a dependency between the included file and the including one.

So if you want to generate dependency rules (using the GCC -M option for exemple), you must use the quoted form for the files that should be included in the dependency tree.

(See http://gcc.gnu.org/onlinedocs/cpp/Invocation.html )

Nicollenicolson answered 25/10, 2011 at 12:35 Comment(1)
Yes - there are several different ways of generating dependencies. That's one of them but it's not the only one.Projectionist
F
20

For #include "" a compiler normally searches the folder of the file which contains that include and then the other folders. For #include <> the compiler does not search the current file's folder.

Forcemeat answered 8/2, 2011 at 11:45 Comment(4)
Not sure why people disagree.Forcemeat
I suspect that's because most people compile only the files in their CWD. If you're in directory foo, and you're compiling foo/unittest/bar.c, and it includes bar.h, then "bar.h" works and <bar.h> does not.Vala
@Maxim people disagree because the behaviour you describe is not standard C.Mccarron
@Spookbuster Right, the standard says both <filename> and "filename" search for implementation-defined places.Forcemeat
S
19

Thanks for the great answers, esp. Adam Stelmaszczyk and piCookie, and aib.

Like many programmers, I have used the informal convention of using the "myApp.hpp" form for application specific files, and the <libHeader.hpp> form for library and compiler system files, i.e. files specified in /I and the INCLUDE environment variable, for years thinking that was the standard.

However, the C standard states that the search order is implementation specific, which can make portability complicated. To make matters worse, we use jam, which automagically figures out where the include files are. You can use relative or absolute paths for your include files. i.e.

#include "../../MyProgDir/SourceDir1/someFile.hpp"

Older versions of MSVS required double backslashes (\\), but now that's not required. I don't know when it changed. Just use forward slashes for compatibility with 'nix (Windows will accept that).

If you are really worried about it, use "./myHeader.h" for an include file in the same directory as the source code (my current, very large project has some duplicate include file names scattered about--really a configuration management problem).

Here's the MSDN explanation copied here for your convenience).

Quoted form

The preprocessor searches for include files in this order:

  1. In the same directory as the file that contains the #include statement.
  2. In the directories of the currently opened include files, in the reverse order in which
    they were opened. The search begins in the directory of the parent include file and
    continues upward through the directories of any grandparent include files.
  3. Along the path that's specified by each /I compiler option.
  4. Along the paths that are specified by the INCLUDE environment variable.

Angle-bracket form

The preprocessor searches for include files in this order:

  1. Along the path that's specified by each /I compiler option.
  2. When compiling occurs on the command line, along the paths that are specified by the INCLUDE environment variable.
Sprage answered 14/10, 2014 at 23:51 Comment(0)
S
15

An #include with angle brackets will search an "implementation-dependent list of places" (which is a very complicated way of saying "system headers") for the file to be included.

An #include with quotes will just search for a file (and, "in an implementation-dependent manner", bleh). Which means, in normal English, it will try to apply the path/filename that you toss at it and will not prepend a system path or tamper with it otherwise.

Also, if #include "" fails, it is re-read as #include <> by the standard.

The gcc documentation has a (compiler specific) description which although being specific to gcc and not the standard, is a lot easier to understand than the attorney-style talk of the ISO standards.

Spinks answered 8/2, 2011 at 12:2 Comment(4)
However, using angle brackets or quotes doesn't affect the way the files are included, it is exactly the same: the preprocessor essentally creates a large source file by copy'n'pasting the code from include files to original source file, before giving it to the compiler (preprocessor does other thing, like #define sustitution, #if evaluation, etc. but the #include processing is that easy)Aiello
What about conflicts? eg say I have zlib.h in my 'user' search paths, and a different version exists in the system search path, then does #include <zlib.h> include the system version and #include "zlib.h" include my own?Zacheryzack
Aha, answered my own question: #22093Zacheryzack
Thank you for acknowledging that both the standard(s) and typical implementation conventions are both relevant here, rather than simply stating that it's unknowable because it's not specified by the standard.Lienlienhard
V
13

Many of the answers here focus on the paths the compiler will search in order to find the file. While this is what most compilers do, a conforming compiler is allowed to be preprogrammed with the effects of the standard headers, and to treat, say, #include <list> as a switch, and it need not exist as a file at all.

This is not purely hypothetical. There is at least one compiler that work that way. Using #include <xxx> only with standard headers is recommended.

Viguerie answered 25/2, 2014 at 10:49 Comment(1)
On a related note, the Standard says nothing about what characters an implementation must accept in filenames, nor what lengths of filenames an implementation must accept. A conforming implementation could run on a file system where filenames were limited to six alphanumeric characters, and reject any directives of the form #include "fname" where the file name contained periods, but a conforming implementation must accept e.g. ` #include <float.h>` without regard for whether float.h would be a valid file name.Ium
T
12
  • #include <> is for predefined header files

If the header file is predefined then you would simply write the header file name in angular brackets, and it would look like this (assuming we have a predefined header file name iostream):

#include <iostream>
  • #include " " is for header files the programmer defines

If you (the programmer) wrote your own header file then you would write the header file name in quotes. So, suppose you wrote a header file called myfile.h, then this is an example of how you would use the include directive to include that file:

#include "myfile.h"
Twinkling answered 17/12, 2012 at 7:54 Comment(2)
It has nothing to do with pre-defined header files at all. It has to do with locations to search for.Hegelian
The question is more general than your answer, which only addresses one aspect of C++ and ignores C. And I agree with C Jonhson. The C++ does support extension-less headers (which are a real pain for some tools, BTW) but it can also be used to identify a file which will be searched with an implementation-specific way as described in the other answers.Ineluctable
L
11
#include "filename" // User defined header
#include <filename> // Standard library header.

Example:

The filename here is Seller.h:

#ifndef SELLER_H     // Header guard
#define SELLER_H     // Header guard

#include <string>
#include <iostream>
#include <iomanip>

class Seller
{
    private:
        char name[31];
        double sales_total;

    public:
        Seller();
        Seller(char[], double);
        char*getName();

#endif

In the class implementation (for example, Seller.cpp, and in other files that will use the file Seller.h), the header defined by the user should now be included, as follows:

#include "Seller.h"
Lipps answered 28/9, 2011 at 20:37 Comment(0)
T
11
#include <abc.h>

is used to include standard library files. So the compiler will check in the locations where standard library headers are residing.

#include "xyz.h"

will tell the compiler to include user-defined header files. So the compiler will check for these header files in the current folder or -I defined folders.

Trifocal answered 23/1, 2017 at 13:36 Comment(0)
D
8
#include <file> 

Includes a file where the default include directory is.

#include "file" 

Includes a file in the current directory in which it was compiled. Double quotes can specify a full file path to a different location as well.

Decisive answered 1/3, 2020 at 23:11 Comment(0)
C
8

"" will search ./ first. Then search the default include path. You can use command like this to print the default include path:

gcc -v -o a a.c

Here are some examples to make thing more clear: the code a.c works

// a.c
#include "stdio.h"
int main() {
        int a = 3;
        printf("a = %d\n", a);
        return 0;

}

the code of b.c works too

// b.c
#include <stdio.h>
int main() {
        int a = 3;
        printf("a = %d\n", a);
        return 0;

}

but when I create a new file named stdio.h in current directory

// stdio.h
inline int foo()
{
        return 10;
}

a.c will generate compile error, but b.c still works

and "", <> can be used together with the same file name. since the search path priority is different. so d.c also works

// d.c
#include <stdio.h>
#include "stdio.h"
int main()
{
        int a = 0;

        a = foo();

        printf("a=%d\n", a);

        return 0;
}
Chafee answered 27/2, 2021 at 16:59 Comment(0)
C
7

In C++, include a file in two ways:

The first one is #include which tells the preprocessor to look for the file in the predefined default location. This location is often an INCLUDE environment variable that denotes the path to include files.

And the second type is #include "filename" which tells the preprocessor to look for the file in the current directory first, then look for it in the predefined locations user have set up.

Cahill answered 17/2, 2016 at 9:7 Comment(0)
A
6

The #include <filename> is used when a system file is being referred to. That is a header file that can be found at system default locations like /usr/include or /usr/local/include. For your own files that needs to be included in another program you have to use the #include "filename" syntax.

Antineutrino answered 27/8, 2014 at 19:36 Comment(0)
D
6

Form 1 - #include < xxx >

First, looks for the presence of header file in the current directory from where directive is invoked. If not found, then it searches in the preconfigured list of standard system directories.

Form 2 - #include "xxx"

This looks for the presence of header file in the current directory from where directive is invoked.


The exact search directory list depends on the target system, how GCC is configured, and where it is installed. You can find the search directory list of your GCC compiler by running it with -v option.

You can add additional directories to the search path by using - Idir, which causes dir to be searched after the current directory (for the quote form of the directive) and ahead of the standard system directories.


Basically, the form "xxx" is nothing but search in current directory; if not found falling back the form

Dempstor answered 17/8, 2018 at 9:59 Comment(4)
If you decide to answer an older question that has well established and correct answers, adding a new answer late in the day may not get you any credit. If you have some distinctive new information, or you're convinced the other answers are all wrong, by all means add a new answer, but 'yet another answer' giving the same basic information a long time after the question was asked usually won't earn you much credit.Keratose
@Jonathan Leffler Can you point me to the "well established" answer that you feel is as concise and accurate as Darshan's answer?Taper
The description of the #include "header.h" form is not accurate, @personal_cloud. I consider the answer by piCookie and Yann Droneaud to be most relevant as they identify where their information comes from. I don't find the top-voted answer to be entirely satisfactory, either.Keratose
Why is this answer shown on top, while two answers further down there is a 650+ votes one? This answer confused me, because it doesn't match the behavior observed by me. This might be, because the last sentence is broken due to not escaping angle brackets. I'm not sure what it is supposed to mean.Bartholomeo
A
5

The simple general rule is to use angled brackets to include header files that come with the compiler. Use double quotes to include any other header files. Most compilers do it this way.

1.9 — Header files explains in more detail about pre-processor directives. If you are a novice programmer, that page should help you understand all that. I learned it from here, and I have been following it at work.

Atchison answered 4/6, 2013 at 15:19 Comment(0)
C
5
#include <filename>

is used when you want to use the header file of the C/C++ system or compiler libraries. These libraries can be stdio.h, string.h, math.h, etc.

#include "path-to-file/filename"

is used when you want to use your own custom header file which is in your project folder or somewhere else.

For more information about preprocessors and header. Read C - Preprocessors.

Cappadocia answered 2/4, 2015 at 16:50 Comment(0)
S
5

#include <filename>

  • The preprocessor searches in an implementation-dependent manner. It tells the compiler to search directory where system header files are held.
  • This method usually use to find standard header files.

#include "filename"

  • This tell compiler to search header files where program is running. If it was failed it behave like #include <filename> and search that header file at where system header files stored.
  • This method usually used for identify user defined header files(header files which are created by user). There for don't use this if you want to call standard library because it takes more compiling time than #include <filename>.
Surgical answered 27/12, 2019 at 5:18 Comment(0)
P
4

the " < filename > " searches in standard C library locations

whereas "filename" searches in the current directory as well.

Ideally, you would use <...> for standard C libraries and "..." for libraries that you write and are present in the current directory.

Pinite answered 28/3, 2018 at 11:35 Comment(1)
Which new information adds this answer to the other ones?Fistulous
D
4

In general the difference is where the preprocessor searches for the header file:

#include is a preprocessor directive to include header file. Both #include are used to add or include header file in the program, but first is to include system header files and later one for user defined header files.

  1. #include <filename> is used to include the system library header file in the program, means the C/C++ preprocessor will search for the filename where the C library files are stored or predefined system header files are stored.
  2. #include "filename" is used to include user defined header file in the program, means the C/C++ preprocessor will search for the filename in the current directory the program is in and then follows the search path used for the #include <filename>

Check the gcc docs gcc include files

Dancy answered 24/11, 2020 at 8:8 Comment(0)
G
3

To see the search order on your system using gcc, based on current configuration , you can execute the following command. You can find more detail on this command here

cpp -v /dev/null -o /dev/null

Apple LLVM version 10.0.0 (clang-1000.10.44.2)
Target: x86_64-apple-darwin18.0.0
Thread model: posix InstalledDir: Library/Developer/CommandLineTools/usr/bin
"/Library/Developer/CommandLineTools/usr/bin/clang" -cc1 -triple x86_64-apple-macosx10.14.0 -Wdeprecated-objc-isa-usage -Werror=deprecated-objc-isa-usage -E -disable-free -disable-llvm-verifier -discard-value-names -main-file-name null -mrelocation-model pic -pic-level 2 -mthread-model posix -mdisable-fp-elim -fno-strict-return -masm-verbose -munwind-tables -target-cpu penryn -dwarf-column-info -debugger-tuning=lldb -target-linker-version 409.12 -v -resource-dir /Library/Developer/CommandLineTools/usr/lib/clang/10.0.0 -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk -I/usr/local/include -fdebug-compilation-dir /Users/hogstrom -ferror-limit 19 -fmessage-length 80 -stack-protector 1 -fblocks -fencode-extended-block-signature -fobjc-runtime=macosx-10.14.0 -fmax-type-align=16 -fdiagnostics-show-option -fcolor-diagnostics -traditional-cpp -o - -x c /dev/null
clang -cc1 version 10.0.0 (clang-1000.10.44.2) default target x86_64-apple-darwin18.0.0 ignoring nonexistent directory "/Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk/usr/local/include" ignoring nonexistent directory "/Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk/Library/Frameworks"
#include "..." search starts here:
#include <...> search starts here:
/usr/local/include
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include
/Library/Developer/CommandLineTools/usr/include
/Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk/usr/include
/Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk/System/Library/Frameworks (framework directory)
End of search list.

Gardenia answered 3/10, 2018 at 18:51 Comment(0)
A
-1

The implementation-defined warnings generated by the compiler can (and will) treat system libraries differently than program libraries.

So

#include <myFilename>

-- which in effect declares that myFilename is in the system library location -- may well (and probably will) hide dead code and unused variable warnings etc, that would show up when you use:

#include "myFilename"

Artwork answered 9/7, 2021 at 4:14 Comment(3)
This is incorrect. While compilers do treat system headers differently, that behavior isn't triggered by using angle brackets in the #include, but by the headers being in specific system directories. See gcc and Microsoft docs on the subject.Ephesus
@Nathan-Reed Read your sources again, try to understand what they mean, and delete your comment.Artwork
I suggest you reread the sources. Again, using angle brackets in the #include does not trigger the system header behavior, as your answer claims. The only exception is with VS with the /external:anglebrackets flag, which is non-default.Ephesus
N
-5

There exists two ways to write #include statement.These are:

#include"filename"
#include<filename>

The meaning of each form is

#include"mylib.h"

This command would look for the file mylib.h in the current directory as well as the specified list of directories as mentioned n the include search path that might have been set up.

#include<mylib.h>

This command would look for the file mylib.h in the specified list of directories only.

The include search path is nothing but a list of directories that would be searched for the file being included.Different C compilers let you set the search path in different manners.

Necropsy answered 18/8, 2018 at 9:24 Comment(2)
If you decide to answer an older question that has well established and correct answers, adding a new answer late in the day may not get you any credit. If you have some distinctive new information, or you're convinced the other answers are all wrong, by all means add a new answer, but 'yet another answer' giving the same basic information a long time after the question was asked usually won't earn you much credit.Keratose
There's nothing new in the answer, other than the "information" that's clearly wrong (an #include-directive is not required to interpret its argument as a file at all). This contribution isn't useful at all. The established answers are both more complete as well as less wrong.Dulci

© 2022 - 2024 — McMap. All rights reserved.