How can I access a user-defined Xcode build setting?

0 votes
asked Oct 19, 2010 by super-cat

If I added a user-defined setting in my build configuration, how can I read that setting in my Objective-C code?

I have two files in my project, debug.plist and release.plist. I want my MainApp.m file to read one of these files based on which build configuration is running. I set up a user-defined setting named "filename" in both the Debug and Release configurations to point to the appropriate file. But I don't know how my MainApp.m file can read the filename variable from the current running configuration.

5 Answers

0 votes
answered Oct 19, 2010 by jwwalker

Your code can't read arbitrary build settings. You need to use preprocessor macros.

EDIT: For example, in the target settings for the Debug configuration, you could add DEBUGGING=1 in the Preprocessor Macros build setting, and not define DEBUGGING in the Release configuration. Then in your source code you could do things like:

#if DEBUGGING
  use this file
#else
  use the other one
#endif
0 votes
answered Oct 17, 2011 by zmippie

Here's what I did, I'm not 100% sure if this is what you're after:

  1. Go into the build Settings panel and choose the gear icon in the bottom left: add User-Defined Setting
  2. Create your user defined setting, for example:

    MY_LANG -> en_us
    
  3. Then, in the Preprocessor Macro's setting, you can reference that value:

    LANGCODE="$(MY_LANG)"
    

Now you can refer to LANGCODE in all your source files, and it will be whatever you filled out in your custom build setting. I realize that there's a level of indirection here, but that is intentional in my case: my XCode project contains a bunch of different targets/configurations with their own preprocessor macro's. I don't want to have to go into all of those, just to change the language code. In fact, I define the language code on the project level. I also use MY_LANG in a couple scripts, so just a preprocessor macro wouldn't do. There may be a smarter way, but this works for me.

0 votes
answered Oct 10, 2013 by morten-holmgaard

I tried zmippie suggestion but it didn't work for me.

I got it working with this:

${MY_LANG}
0 votes
answered Sep 15, 2017 by simon-tillson

In case anyone else is still stuck looking for how to do preprocessor macros, look for the Apple LLVM - Preprocessing section in Build Settings. Under it, you will see a section called Preprocessor Macros.

This is where by default, Xcode inserts the DEBUG=1 macro for the debug build configuration.

You can add your own here, and give them different values for debug, release and any custom build configs you may have.

To add one, double-click on the current value list for the config you want, and it'll display a nice little editor with one macro on each line. Just add your own macro name, and give it a value the same way the DEBUG one is done.

These can be checked during the preprocessor build phase using #if, #ifdef etc. to provide conditional code or values.

Hope that helps.

0 votes
answered Sep 15, 2017 by andydeveloper

You can access your user-defined build setting at run-time (as suggested in a comment by @JWWalker)

  1. Add an entry to your Info.plist file, and set it to your User-defined Build Setting

    MySetting -> ${MYSETTING}
    
  2. Read its value from code

    [[NSBundle mainBundle] objectForInfoDictionaryKey:@"MySetting"];
    
Welcome to Q&A, where you can ask questions and receive answers from other members of the community.
Website Online Counter

...