Separating a group of functions into an includable file in C? - c

I know this is common in most languages, and maybe in C, as well. Can C handle separating several functions out to a separate file and having them be included?
The functions will rely on other include files, as well. I want the code to retain all functionality, but the code will be reused in several C scripts, and if I change it once I do not wish to have to go through every script and change it there, too.

Most definitely! What you're describing are header files. You can read more about this process here, but I'll outline the basics below.
You'll have your functions separated into a header file called functions.h, which contains the following:
int return_ten();
Then you can have a functions.c file which contains the definition of the function:
int return_ten()
{
return 10;
}
Then in your main.c file you can include the functions.h in the following way:
#include <stdio.h>
#include "functions.h"
int main(int argc, char *argv[])
{
printf("The number you're thinking of is %d\n", return_ten());
return 0;
}
This is assuming that your functions.h file is in the same directory as your main.c file.
Finally, when you want to compile this into your object file you need to link them together. Assuming you're using a command-line compiler, this just means adding the extra definition file onto the end. For the above code to work, you'd type the follow into your cmd: gcc main.c functions.c which would produce an a.out file that you can run.

Declare the functions in header files and then implement them in .c files. Now you can #include the header files into any program that uses the functions and then link the program against the object files generated from the .c files.

Say you have a file with a function that you want to use elsewhere:
int func2(int x){
/*do some stuff */
return 0;
}
what you would do is split this up into a header file and a source file. In the header file you just have the function declaration, this tells the compiler that that function does exist, even if it is in a different file. The header might be called func2.h might look like this:
#ifndef HEADER_FUNC2_H
#define HEADER_FUNC2_H
int func2(int x);
#endif /*HEADER_FUNC2_H*/
The #ifndef HEADER_FUNC2_H part is to make sure that this only gets used once so that there are no multiple definitions going on.
then in the source func2.c file you have the actual function itself:
int func2(int x){
/*do some stuff */
return 0;
}
and in any other file now that you use func2 you have to include the header. You do this with #include "func2.h". So for example if we wanted to call func2 from randomfile.c it would be like this:
#include "func2.h"
/* rest of randomfile.c */
func2(1);
Then the last step is to link the object file that contains the function with the compiler when you compile.

If you want to reuse functions across multple programs, you should place them in a library and link it with the rest of your code.
If you want to share the same definitions (e.g. macros, types, ...) you can place them in a header file and include them with #include.
Please refrain from directly "#include" function code into a source file, it's a bad practice and can lead to very problematic situations (especially if you are a beginner, as your tag suggests).
Consder that normally when you have a set of functions you want to share and reuse, you will need both! You will usually end up with a myfuncs.lib (or libmyfuncs.a) library and a myfuncs.h header.
In the programs where you want to reuse your existing functions, you will include the header and link against the library.
You can also look at how to use dynamic libraries once you have mastered the usage of static libraries.

Related

How can I handle several files in the same program using a single header?

I struggle to understand the way the C manual recommends to write functions in separate files.
When I want to write functions in a separate file with respect to the main, what I usually do is create a header file stuff.h and put everything there:
// this is the stuff.h file
int function_from_stuff(int b)
{
return 2*b;
}
then in the file main.c I will write
// this is the main.c file
#include "stuff.h"
int main()
{
int b=2;
int a=function_from_stuff(b);
printf("%d", a);
return 0;
}
and it all works well.
In the manual (chapter 4.5 Header Files in my edition) , they rather recommend to have several .c files where the functions are defined, and to use the header file only to declare them. So, in my trivial example, they would do something like
// this is the stuff.h file
int function_from_stuff(int b);
and then also create a another separate second_file.c file:
// this is the second_file.c file
#include "stuff.h"
int function_from_stuff(int b)
{
return 2*b;
}
Now, what I do not understand is how this can work, what the compiling order must be, and how I am going to signal the machine that I want second_file.c to be part of the program.
How exactly to do this is entirely dependent on which compiler you use.
what the compiling order must be
The order in which source files are compiled is not particularly important. Each produces an object file, which are then linked together. I suggest you read up on the compilation process if you want to know more about this.
how I am going to signal the machine that I want second_file.c to be part of the program.
This is generally done by simply adding adding second_file.c to your list of source files, but again this is compiler-dependent.

How do I create a library in C?

I am working on a program that is using libgit2. I had kept the code in a single c file. Say:
somefile.c
I compile and use it. Now I want to separate some of the details related to libgit2 into a separate library inside the project. So I created an h file with the data structures that I need and the definitions of the functions I want to use. So far, nothing fancy: init stuff, pass in the path to the repo and s a treeish... those are const * constant.... then In the library c file I have an implementation of the functions in the .h file.
Currently, the layout is like this:
include/mylib.c
include/mylib.h
somefile.c
In include/mylib.h I have one struct and a couple of functions:
struct blah {} blah_info;
int blah_init(cont char * path, const char * treeish);
int blah_shutdown();
In include/mylib.c I include mylib.h:
#include "mylib.h" # notice that I don't have to use "include" in the path
And then I have definitions for the 2 functions that I put in the .h file.
In somefile.c now I am including the library c file, not the .h file (and no need to include git2.h anymore either as that is done in mylib files now).
#include "include/mylib.c"
And this allows me to compile and run the program, just like it did before I separated it into pieces but I know it's possible to include include/mylib.h from the original .c file. I think it requires to build the library before then going into compiling the final program? What steps are required for that?
Right now I'm compiling by hand in a shell script calling GCC in a single shot... so if I need to run more commands to do so, just let me know so that I add them to the script.
In somefile.c, you need to do this:
#include "include/mylib.h"
And make sure you define these functions in mylib.c:
int blah_init(cont char * path, const char * treeish) {
}
int blah_shutdown() {
}
And then declare them in mylib.h:
struct blah {} blah_info;
int blah_init(cont char * path, const char * treeish);
int blah_shutdown();
And when you compile, include both somefile.c and mylib.c as input files.
#include directive is used to insert content of a file somewhere else and it's mostly used to include headers so compiler knows what is what (types, constants, etc), then linker puts all compiled files into one single executable.
to make sure header is included only once to a single file you use something called conditional compilation, it's done with preprocessor (before compilation)
yourlib.h
#ifndef YOUR_LIB_H_ //there are many naming conventions but I prefer this one
#define YOUR_LIB_H_
//all your declarations go here
#endif //YOUR_LIB_H_
//you should put in comment what's that condition for after every endif
now in yourlib.c you include that header and then write your definitions
#include "yourlib.h"
//all your definitions go here
and same thing for your main file, just include the header and compiler knows what to do
#include "yourlib.h"
//your code goes here

#include "another_source.c", use inline function( ) there, then does the function( ) become inline as well?

Let's say I have two files named "AA.c", "BB.c"
/* in AA.c */
inline void AA(void) __attribute__((always_inline));
void AA()
{
/* do something */
}
and then
/* in BB.c */
#include "AA.c"
extern void funcAA(void);
int main(void)
{
funcAA();
return 0;
}
does funcAA( ) also become inline???
no matter the answer is yes or no, could you explain some more about the under the hood??
including a .c file is equivalent of copying and pasting the file contents directly in the file which includes that, exactly like if the function was directly defined in the including file.
You can see what the compiler is going to compile by trying to compile your file with -E flag (preprocessor output). You'll see your function pasted-in.
So it will be inline just because of the inline keyword, and forced with the always_inline attribute even if the compiler would have refused to inline it because of function size for instance.
Word of advice: know what you're doing when including a .c file from another one. Some build systems/makefiles just scan the directories looking for files called *.c so they can compile them separately. Putting a possibly non-compiling C file there can make the build fail, and if it builds, you could have duplicate symbols when linking. Just don't do this.
If you want to do this, put your function in a .h file and declare it static so it won't fail the link if included in many .c files (each function will be seen as different)

C file extension if you include C file inside another

I have a C file with all static functions, related to one and same sub-task.
Some of the functions are quite long - 20-30 lines.
I want to include it in another C file.
What must be the file extension (in order things to considered professional). Shall I do it as H file?
20-30 lines isn't long. 200-300 lines is getting long but still doesn't warrant a separate file.
Most projects would be unmanageable if 20 line functions had their own file.
Just put the functions in the .c file they're used in and declare them static.
I don't know what build tool you're using but traditional 'make' might get confused by .c unless you introduce further rules and discipline.
If you do put them in another file give it the .inc suffix as others suggest.
I have generally only seen people do this when the .inc is maintained by an external tool.
If you really need to share the same static methods across multiple c files (for compiler optimization?), you should place them in a .c-file and not in a .h file.
If you don't need to make those methods static, you should really place them in a single .c module which is liked to the binary and only share the definitions across the modules using them.
Example
If you really have to share the static functions and you have a really good reason
static_functions.c (I'd name it static_functions.inc.c, but that's personal flavour)
static int max(int a, int b) {
if (a > b)
return a;
return b;
}
module-x.c for some x
#include "static_functions.c"
int use_max() {
return max(1,2);
}
Compile module-x.c only.
If you don't really need static versions
internal_functions.h
#ifndef internal_functions_h
#define internal_functions_h
int max(int a, int b);
#endif
internal_functions.c
#include "internal_functions.h"
int max(int a, int b) {
if (a > b)
return a;
return b;
}
module-x.c for some x
#include "internal_functions.h"
int use_max() {
return max(1,2);
}
And then compile and link together internal_functions.c and module-x.c.
To have the definitions local only, you don't need to use or ship your internal_functions.h elsewhere.
include C file inside another
No, not the way. Conventionally,
.c [source files] are meant to be compiled and linked together
.h [Header files] are there to be included.
C file with all static methods [] Shall I do it as H file?
No. Ideally header files [.h] are not supposed to contain any definition. There should be declarations only. Otherwise, if a header file .h contains definitions and you've got included them more than once, you'll be facing multiple definition issue.
I have a little doubt regarding
C file with all static methods.
If all the methods [functions] are static, how to use them, anyway?
However, the way for you will be taking all the related .c files, compile and link them together to form the final binary.
Do not include separate c files. Just compile them separately as they are.
Suppose you have two files with code: main.c and include.c.
Rather than having #include "include.c" inside main.c, when you compile link the object files:
gcc main.c include.c

How to use a function from an object file

I'm pretty sure this question is a duplicate, but can't find an answer.
I wrote a function (in "function.h" and "function.c" files), and compiled it to "function.o" file. I want to use the function defined in "function.c" in my main source, but without including "function.h". Is that possible, to compile main.c using just "function.o"?
A header file is (usually) just a list of declarations which are inserted textually (by #include) into your source files.
Therefore, if function.h contains
void foo(int x);
and you have #include "function.h" in your main source file, it is exactly equivalent to just writing void foo(int x); in your source file.
Header files are useful for code organization because it would be highly inefficient (and error-prone) to copy those declarations by hand into every source file that used them. But, if you want to avoid the header file for any reason, copying those declarations directly into your source file has the same effect as #include'ing the file.

Resources