-
-
Notifications
You must be signed in to change notification settings - Fork 375
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add human-readable representation of common machine recipe context tags
- Loading branch information
1 parent
e162bab
commit e5fd6ea
Showing
17 changed files
with
275 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
169 changes: 169 additions & 0 deletions
169
LookupAnything/Framework/HumanReadableContextTagParser.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| using System; | ||
| using System.Diagnostics.CodeAnalysis; | ||
| using StardewValley; | ||
| using StardewValley.ItemTypeDefinitions; | ||
| using Object = StardewValley.Object; | ||
|
|
||
| namespace Pathoschild.Stardew.LookupAnything.Framework | ||
| { | ||
| /// <summary>Parses context tags into human-readable representations where possible.</summary> | ||
| internal static class HumanReadableContextTagParser | ||
| { | ||
| /********* | ||
| ** Public methods | ||
| *********/ | ||
| /// <summary>Get a human-readable representation of a context tag, if available.</summary> | ||
| /// <param name="contextTag">The raw context tag to parse.</param> | ||
| public static string Parse(string contextTag) | ||
| { | ||
| if (string.IsNullOrWhiteSpace(contextTag)) | ||
| return contextTag; | ||
|
|
||
| // extract negation | ||
| bool negate = contextTag.StartsWith('!'); | ||
| string actualTag = negate | ||
| ? contextTag[1..] | ||
| : contextTag; | ||
|
|
||
| // parse | ||
| if ( | ||
| HumanReadableContextTagParser.TryParseCategory(actualTag, out string? parsed) | ||
| || HumanReadableContextTagParser.TryParseItemId(actualTag, out parsed) | ||
| || HumanReadableContextTagParser.TryParseSpecial(actualTag, out parsed) | ||
| ) | ||
| { | ||
| return negate | ||
| ? I18n.ContextTag_Negate(tag: parsed) | ||
| : parsed; | ||
| } | ||
|
|
||
| return contextTag; | ||
| } | ||
|
|
||
|
|
||
| /********* | ||
| ** Private methods | ||
| *********/ | ||
| /// <summary>Parse a context tag which refers to a category, if applicable.</summary> | ||
| /// <param name="tag">The context tag.</param> | ||
| /// <param name="parsed">The human-readable form.</param> | ||
| /// <returns>Returns whether it was parsed successfully.</returns> | ||
| /// <remarks>This implementation is based on <see cref="ItemContextTagManager.GetBaseContextTags"/>.</remarks> | ||
| private static bool TryParseCategory(string tag, [NotNullWhen(true)] out string? parsed) | ||
| { | ||
| int? category = tag switch | ||
| { | ||
| "category_artisan_goods" => Object.artisanGoodsCategory, | ||
| "category_bait" => Object.baitCategory, | ||
| "category_big_craftable" => Object.BigCraftableCategory, | ||
| "category_boots" => Object.bootsCategory, | ||
| "category_clothing" => Object.clothingCategory, | ||
| "category_cooking" => Object.CookingCategory, | ||
| "category_crafting" => Object.CraftingCategory, | ||
| "category_egg" => Object.EggCategory, | ||
| "category_equipment" => Object.equipmentCategory, | ||
| "category_fertilizer" => Object.fertilizerCategory, | ||
| "category_fish" => Object.FishCategory, | ||
| "category_flowers" => Object.flowersCategory, | ||
| "category_fruits" => Object.FruitsCategory, | ||
| "category_furniture" => Object.furnitureCategory, | ||
| "category_gem" => Object.GemCategory, | ||
| "category_greens" => Object.GreensCategory, | ||
| "category_hat" => Object.hatCategory, | ||
| "category_ingredients" => Object.ingredientsCategory, | ||
| "category_junk" => Object.junkCategory, | ||
| "category_litter" => Object.litterCategory, | ||
| "category_meat" => Object.meatCategory, | ||
| "category_milk" => Object.MilkCategory, | ||
| "category_minerals" => Object.mineralsCategory, | ||
| "category_monster_loot" => Object.monsterLootCategory, | ||
| "category_ring" => Object.ringCategory, | ||
| "category_seeds" => Object.SeedsCategory, | ||
| "category_sell_at_fish_shop" => Object.sellAtFishShopCategory, | ||
| "category_syrup" => Object.syrupCategory, | ||
| "category_tackle" => Object.tackleCategory, | ||
| "category_tool" => Object.toolCategory, | ||
| "category_vegetable" => Object.VegetableCategory, | ||
| "category_weapon" => Object.weaponCategory, | ||
| "category_sell_at_pierres" => Object.sellAtPierres, | ||
| "category_sell_at_pierres_and_marnies" => Object.sellAtPierresAndMarnies, | ||
| "category_metal_resources" => Object.metalResources, | ||
| "category_building_resources" => Object.buildingResources, | ||
| "category_trinket" => Object.trinketCategory, | ||
| _ => null | ||
| }; | ||
|
|
||
| if (category.HasValue) | ||
| { | ||
| string displayName = Object.GetCategoryDisplayName(category.Value); | ||
| if (!string.IsNullOrWhiteSpace(displayName)) | ||
| { | ||
| parsed = displayName; | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| parsed = null; | ||
| return false; | ||
| } | ||
|
|
||
| /// <summary>Parse a context tag which refers to an item ID, if applicable.</summary> | ||
| /// <param name="tag">The context tag.</param> | ||
| /// <param name="parsed">The human-readable form.</param> | ||
| /// <returns>Returns whether it was parsed successfully.</returns> | ||
| /// <remarks>This implementation is based on <see cref="Utility.getItemFromStandardTextDescription(string,Farmer,char)"/>.</remarks> | ||
| private static bool TryParseItemId(string tag, [NotNullWhen(true)] out string? parsed) | ||
| { | ||
| if (tag.StartsWith("id_")) | ||
| { | ||
| string rawIdentifier = tag[3..]; | ||
| string? qualifiedId = null; | ||
|
|
||
| // extract qualified item ID | ||
| if (rawIdentifier.StartsWith('(')) | ||
| qualifiedId = rawIdentifier; | ||
| else | ||
| { | ||
| string[] parts = rawIdentifier.Split('_', 2); | ||
|
|
||
| foreach (IItemDataDefinition type in ItemRegistry.ItemTypes) | ||
| { | ||
| if (string.Equals(parts[0], type.StandardDescriptor, StringComparison.InvariantCultureIgnoreCase)) | ||
| { | ||
| qualifiedId = type.Identifier + parts[1]; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // get item name if valid | ||
| string? name = ItemRegistry.GetData(qualifiedId)?.DisplayName; | ||
| if (!string.IsNullOrWhiteSpace(name)) | ||
| { | ||
| parsed = name; | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| parsed = null; | ||
| return false; | ||
| } | ||
|
|
||
| /// <summary>Parse a hardcoded context tag, if applicable.</summary> | ||
| /// <param name="tag">The context tag.</param> | ||
| /// <param name="parsed">The human-readable form.</param> | ||
| /// <returns>Returns whether it was parsed successfully.</returns> | ||
| /// <remarks>This implementation is based on <see cref="Utility.getItemFromStandardTextDescription(string,Farmer,char)"/>.</remarks> | ||
| private static bool TryParseSpecial(string tag, [NotNullWhen(true)] out string? parsed) | ||
| { | ||
| parsed = tag switch | ||
| { | ||
| "bone_item" => I18n.ContextTag_Bone(), | ||
| "egg_item" => I18n.ContextTag_Egg(), | ||
| "large_egg_item" => I18n.ContextTag_LargeEgg(), | ||
| _ => null | ||
| }; | ||
| return parsed != null; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters