Visual Studio - include external library

Visual Studio - Include External Library (Using JSON as an Example)

This guide explains how to include an external library in Visual Studio using nlohmann/json (a popular JSON library for C++).

---

1. Download and Add JSON Library

The nlohmann/json library is header-only, meaning you just need a single file: json.hpp.

Option 1: Manual Installation

1. Download json.hpp

• Get the latest json.hpp file from the official GitHub repository.
• Alternatively, copy json.hpp from the single_include directory.

2. Place it in Your Project

• Copy json.hpp to your project’s include folder (e.g., C:\MyProject\include).

3. Include it in Your Code

#include <nlohmann/json.hpp>

using json = nlohmann::json;

---

Option 2: Use vcpkg to Install

If you use vcpkg, you can install the library automatically:

1. Open PowerShell or Command Prompt.

2. Run:

vcpkg install nlohmann-json

3. Link vcpkg to Visual Studio (if not done already):

vcpkg integrate install

4. Now, you can include the JSON library directly in your project.

---

2. Configure Visual Studio to Include the Library

If you installed the library manually, configure Visual Studio to recognize the header file.

1. Open Project Properties

• Right-click your project in Solution Explorer → Select Properties.

2. Set Include Directory

• Go to C/C++ → General → Additional Include Directories.
• Add the path to json.hpp (e.g., C:\MyProject\include).

---

3. Example Usage of JSON Library

Basic JSON Object Creation

#include <iostream>
#include <nlohmann/json.hpp>

using json = nlohmann::json;

int main() {
    // Create a JSON object
    json j;
    j["name"] = "Alice";
    j["age"] = 25;
    j["is_student"] = false;

    // Convert to string and print
    std::cout << j.dump(4) << std::endl; // Pretty print with indentation

    return 0;
}

Output:

{
    "name": "Alice",
    "age": 25,
    "is_student": false
}

---

4. Handling JSON Parsing and File I/O

Parse JSON from a String

#include <iostream>
#include <nlohmann/json.hpp>

using json = nlohmann::json;

int main() {
    std::string json_str = R"({"language": "C++", "version": 2022})";
    json parsed_json = json::parse(json_str);

    std::cout << "Language: " << parsed_json["language"] << std::endl;
    std::cout << "Version: " << parsed_json["version"] << std::endl;

    return 0;
}

Read and Write JSON Files

#include <iostream>
#include <fstream>
#include <nlohmann/json.hpp>

using json = nlohmann::json;

int main() {
    // Create JSON data
    json j;
    j["title"] = "Visual Studio JSON Example";
    j["version"] = 1.0;

    // Save JSON to a file
    std::ofstream outFile("config.json");
    outFile << j.dump(4); // Pretty print
    outFile.close();

    // Read JSON from a file
    std::ifstream inFile("config.json");
    json loaded_json;
    inFile >> loaded_json;

    std::cout << "Loaded JSON: " << loaded_json.dump(4) << std::endl;

    return 0;
}

---

5. Common Issues and Fixes

❌ Unsupported block ($table)

---

Summary

• Download and include json.hpp manually or install via vcpkg.
• Add the include directory to Visual Studio Project Properties.
• Use #include <nlohmann/json.hpp> to start working with JSON.
• Read, write, and manipulate JSON using nlohmann::json.

This method applies to any header-only or external library in Visual Studio. 🚀

---

Click here to share this article with your friends on X if you liked it.