Wczytanie i zapisywanie ciągu JSON z komentarzami

Wczytanie i zapisywanie ciągu JSON z komentarzami
Marius.Maximus
Marius.Maximus
Marius.Maximus
Marius.Maximus
  • Rejestracja:ponad 14 lat
  • Ostatnio:dzień
  • Postów:2067
0

Tak się zastanawiam , inżynier edytuje pliki konfiguracji JSON i dopisuje komentarze
nie inżynier posiada interfejs KLIK-KLIK i też edytuje ten sam plik JSON ale za pomocą GUI
Jak zachować komentarze przy zapisaniu w GUI ?

Kopiuj
// przykład z https://json.nlohmann.me/features/comments/
// https://godbolt.org/z/TWGvP1eE5
#include <iostream>
//#define JSON_DIAGNOSTICS 0   // dodatkowa diagnostyka na konsoli 
#include <nlohmann/json.hpp>

using json = nlohmann::json;

int main()
{
    std::string s = R"(
    {
            // update in 2006: removed Pluto
        "planets": ["Mercury", "Venus", "Earth", "Mars",
                    "Jupiter", "Uranus", "Neptune" /*, "Pluto" */ ]
    }
    )";


    try
    {
        json j = json::parse(s);
    }
    catch (json::exception &e)
    {
        std::cout << e.what() << std::endl;
    }

    json j = json::parse(s,
                         /* callback */ nullptr,
                         /* allow exceptions */ true,
                         /* ignore_comments */ true);
    std::cout << j.dump(2) << '\n';
    std::cout << "EOF\n";
}
--
Nie przyjmuję reklamacji za moje rady, używasz na własną odpowiedzialność.
Programowanie bez formatowania to jak chodzenie ze spodniami spuszczonymi na kostki. Owszem da się ale po pierwsze nie wygodne, po drugie nieprzyzwoicie wygląda.
Przed zaczęciem nowego wątku przeczytam problem XY
edytowany 1x, ostatnio: Riddle
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
jurek1980
jurek1980
jurek1980
jurek1980
  • Rejestracja:ponad 8 lat
  • Ostatnio:około 7 godzin
  • Postów:3457
4
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Marius.Maximus
Marius.Maximus
Marius.Maximus
Marius.Maximus
  • Rejestracja:ponad 14 lat
  • Ostatnio:dzień
  • Postów:2067
0

Standard standardem a życie życiem ;)
Na stronach Microsoftu dla programistów tez pojawia się komentarz w JSON ;) Choć ta firma nigdy nie trzymała standardów i to nie najlepszy przykład
Visual Studio Code tez ma tak zrobioną konfiguracje że można edytować ręcznie z komentarzami a potem wyklinać i komentarze zostają, zamarzyło mi się podobnie.

--
Nie przyjmuję reklamacji za moje rady, używasz na własną odpowiedzialność.
Programowanie bez formatowania to jak chodzenie ze spodniami spuszczonymi na kostki. Owszem da się ale po pierwsze nie wygodne, po drugie nieprzyzwoicie wygląda.
Przed zaczęciem nowego wątku przeczytam problem XY
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
jurek1980
jurek1980
jurek1980
jurek1980
  • Rejestracja:ponad 8 lat
  • Ostatnio:około 7 godzin
  • Postów:3457
1

Hmm. Może podaj przykład z życia takiego pliku z tej dokumentacji. Bo może to było tylko edukacyjnie dopisane. Nie znam się na C/C++ ale to co opisujesz to raczej próba złamania standardu i chyba musiałbyś własny parser napisać.

Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
LukeJL
LukeJL
LukeJL
LukeJL
  • Rejestracja:około 11 lat
  • Ostatnio:11 minut
  • Postów:8398
3

widziałem gdzieś modyfikacje formatu JSON, że są komentarze. Tylko to nie jest standardowy JSON i nie nadaje się to jako przenośny format. No i ja to widziałem w ekosystemie JS, nie wiem czy jest do tego parser w C++

Mógłbyś tez zapisywać to w YAML zamiast w JSON, a tam już są komentarze. Tylko znowu - to inny format, chociaż mógłbyś to jakoś przekonwertować potem do JSON.

Albo możesz po prostu zapisywać te komentarze w jakimś dodatkowym polu w JSON:

Kopiuj

 
           "comment": "update in 2006: removed Pluto",
        "planets": ["Mercury", "Venus", "Earth", "Mars",
                    "Jupiter", "Uranus", "Neptune" ]

Tylko, że byłoby to na mocy konwencji. Jakbyś podawał tego JSONa gdzieś dalej, to te dane mogłyby zostać źle zinterpretowane jako coś ważnego

edytowany 3x, ostatnio: LukeJL
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Riddle
Riddle
Riddle
Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:około 9 godzin
  • Lokalizacja:Laska, z Polski
  • Postów:10055
1
Adamek Adam napisał(a):

Tak się zastanawiam , inżynier edytuje pliki konfiguracji JSON i dopisuje komentarze
nie inżynier posiada interfejs KLIK-KLIK i też edytuje ten sam plik JSON ale za pomocą GUI

Dla mnie to wygląda tak, że:

  • Dwie osoby korzystają z pewnej technologii czy formatu
  • Ta technologia nie do końca spełnia ich oczekiwania (np nie ma komentarzy)
  • Więc te osoby dodają coś co jest nie za bardzo zgodne z tą technologią, i "nawet działa"
  • Potem trzeba coś dodać, zmienić albo żyć z tym
  • I pojawia się taki absurdalny pomysł: "SIEMA JAK DODAC KOMENTARZE DO JSON'a".

Ja osobiście nie znam żadnego formatu JSON-ono podobnego który miałbym komentarze. Więc moim zdaniem wyjscia jakie masz to:

  • Albo skorzystać z innego formatu, jak mówili przed mówiący (np yaml)
  • Albo "wymyślić" swój format (chociaż wygląda że już wymyśliliście: JSON z komentarzami) i napisać odpowiednie parsery i serializery do niego, ale łatwe to nie będzie.
Adamek Adam napisał(a):

Jak zachować komentarze przy zapisaniu w GUI ?

Zachować moim zdaniem się nie da, bo komentarze nie są elementem tego formatu.

Masz do wyboru albo skorzystać z gotowego narzędzia (ale narzędzia są tworzone z reguł do istniejących formatów, a formatu który wspiera komentarze w JSON raczej nie ma); albo napisać samemu swój serializer i parser.

edytowany 4x, ostatnio: Riddle
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Marius.Maximus
Marius.Maximus
Marius.Maximus
Marius.Maximus
  • Rejestracja:ponad 14 lat
  • Ostatnio:dzień
  • Postów:2067
0

Jak to nie jest takie proste (na 10 minut) to warto się zastanowić czy brnąc w tym kierunku.

nlohmann::json wczytuje poprawnie pliki z komentarzami , ma też wbudowany mechanizm podczepienia własnej funkcji w proces parsowania JSON,
wiec teoretycznie dało by się to zrobić bez rozkopywania biblioteki, zapisać komentarze poza obiektem i przy zapisaniu odtworzyć , takie subtelne rozszerzenie.

Koncept:

  • przerobić aby callback przechwytywał komentarze (w tym monecie parser przeskakuje do końca komentarza )
  • w callback użytkownika zapamiętać komentarz oraz obiekt którego dotyczy np. std:map<string,string>
  • dodać funkcję która zwraca JSON z zapamiętanymi komentarzami
--
Nie przyjmuję reklamacji za moje rady, używasz na własną odpowiedzialność.
Programowanie bez formatowania to jak chodzenie ze spodniami spuszczonymi na kostki. Owszem da się ale po pierwsze nie wygodne, po drugie nieprzyzwoicie wygląda.
Przed zaczęciem nowego wątku przeczytam problem XY
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Treść
Podgląd
Kliknij, aby dodać treść...
Kliknij, aby dodać załącznik lub wklej ze schowka.
Instrukcja obsługi Markdown
Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)