File indexing completed on 2025-03-09 05:18:52
0001 /* 0002 * Copyright (c) 2018 Sune Vuorela <sune@vuorela.dk> 0003 * 0004 * Permission is hereby granted, free of charge, to any person 0005 * obtaining a copy of this software and associated documentation 0006 * files (the "Software"), to deal in the Software without 0007 * restriction, including without limitation the rights to use, 0008 * copy, modify, merge, publish, distribute, sublicense, and/or sell 0009 * copies of the Software, and to permit persons to whom the 0010 * Software is furnished to do so, subject to the following 0011 * conditions: 0012 * 0013 * The above copyright notice and this permission notice shall be 0014 * included in all copies or substantial portions of the Software. 0015 * 0016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 0017 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 0018 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 0019 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 0020 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 0021 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 0022 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 0023 * OTHER DEALINGS IN THE SOFTWARE. 0024 */ 0025 #pragma once 0026 #include "ingredientsextractor.h" 0027 #include <QVector> 0028 #include <QMap> 0029 0030 class QIODevice; 0031 0032 /** 0033 * Extract information from a recipe. See format documentation for details. 0034 */ 0035 namespace RecipeParser 0036 { 0037 /** 0038 * A parsed recipe with metadata extracted 0039 */ 0040 struct ParsedRecipe 0041 { 0042 /** The recipe title*/ 0043 QString title; 0044 /** A list of ingredients */ 0045 QVector<IngredientsExtractor::Ingredient> ingredients; 0046 /** The tags extracted from the metadata*/ 0047 QVector<QString> tags; 0048 /** Less formalized bits of metadata. At a more formal point, it might 0049 deserve to be treated like tags */ 0050 QMap<QString,QVector<QString>> otherMeta; // we want them ordered 0051 }; 0052 /** 0053 * Parses a recipe 0054 * \param input open QIODevice to read the recipe from 0055 * \return Parsed Recipe. 0056 */ 0057 ParsedRecipe parseRecipe(QIODevice* input); 0058 };