"),i.fl()},partials:{},subs:{}}),t.defaultTemplates["tag-file-added"]=new l.Template({code:function(e,t,n){var i=this;return i.b(n=n||""),i.b('ADDED'),i.fl()},partials:{},subs:{}}),t.defaultTemplates["tag-file-changed"]=new l.Template({code:function(e,t,n){var i=this;return i.b(n=n||""),i.b('CHANGED'),i.fl()},partials:{},subs:{}}),t.defaultTemplates["tag-file-deleted"]=new l.Template({code:function(e,t,n){var i=this;return i.b(n=n||""),i.b('DELETED'),i.fl()},partials:{},subs:{}}),t.defaultTemplates["tag-file-renamed"]=new l.Template({code:function(e,t,n){var i=this;return i.b(n=n||""),i.b('RENAMED'),i.fl()},partials:{},subs:{}})},834:function(e,t,n){"use strict";var i=this&&this.__createBinding||(Object.create?function(e,t,n,i){void 0===i&&(i=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,i,r)}:function(e,t,n,i){void 0===i&&(i=n),e[i]=t[n]}),r=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var n in e)"default"!==n&&Object.prototype.hasOwnProperty.call(e,n)&&i(t,e,n);return r(t,e),t},l=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.html=t.parse=t.defaultDiff2HtmlConfig=void 0;const a=s(n(468)),o=s(n(479)),c=s(n(378)),d=s(n(170)),f=n(699),u=l(n(63));t.defaultDiff2HtmlConfig=Object.assign(Object.assign(Object.assign({},c.defaultLineByLineRendererConfig),d.defaultSideBySideRendererConfig),{outputFormat:f.OutputFormatType.LINE_BY_LINE,drawFileList:!0}),t.parse=function(e,n={}){return a.parse(e,Object.assign(Object.assign({},t.defaultDiff2HtmlConfig),n))},t.html=function(e,n={}){const i=Object.assign(Object.assign({},t.defaultDiff2HtmlConfig),n),r="string"==typeof e?a.parse(e,i):e,s=new u.default(i);return(i.drawFileList?o.render(r,s):"")+("side-by-side"===i.outputFormat?new d.default(s,i).render(r):new c.default(s,i).render(r))}},479:function(e,t,n){"use strict";var i=this&&this.__createBinding||(Object.create?function(e,t,n,i){void 0===i&&(i=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,i,r)}:function(e,t,n,i){void 0===i&&(i=n),e[i]=t[n]}),r=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var n in e)"default"!==n&&Object.prototype.hasOwnProperty.call(e,n)&&i(t,e,n);return r(t,e),t};Object.defineProperty(t,"__esModule",{value:!0}),t.render=void 0;const l=s(n(741)),a="file-summary";t.render=function(e,t){const n=e.map((e=>t.render(a,"line",{fileHtmlId:l.getHtmlId(e),oldName:e.oldName,newName:e.newName,fileName:l.filenameDiff(e),deletedLines:"-"+e.deletedLines,addedLines:"+"+e.addedLines},{fileIcon:t.template("icon",l.getFileIcon(e))}))).join("\n");return t.render(a,"wrapper",{filesNumber:e.length,files:n})}},63:function(e,t,n){"use strict";var i=this&&this.__createBinding||(Object.create?function(e,t,n,i){void 0===i&&(i=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,i,r)}:function(e,t,n,i){void 0===i&&(i=n),e[i]=t[n]}),r=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var n in e)"default"!==n&&Object.prototype.hasOwnProperty.call(e,n)&&i(t,e,n);return r(t,e),t};Object.defineProperty(t,"__esModule",{value:!0});const l=s(n(485)),a=n(979);t.default=class{constructor({compiledTemplates:e={},rawTemplates:t={}}){const n=Object.entries(t).reduce(((e,[t,n])=>{const i=l.compile(n,{asString:!1});return Object.assign(Object.assign({},e),{[t]:i})}),{});this.preCompiledTemplates=Object.assign(Object.assign(Object.assign({},a.defaultTemplates),e),n)}static compile(e){return l.compile(e,{asString:!1})}render(e,t,n,i,r){const s=this.templateKey(e,t);try{return this.preCompiledTemplates[s].render(n,i,r)}catch(e){throw new Error(`Could not find template to render '${s}'`)}}template(e,t){return this.preCompiledTemplates[this.templateKey(e,t)]}templateKey(e,t){return`${e}-${t}`}}},378:function(e,t,n){"use strict";var i=this&&this.__createBinding||(Object.create?function(e,t,n,i){void 0===i&&(i=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,i,r)}:function(e,t,n,i){void 0===i&&(i=n),e[i]=t[n]}),r=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var n in e)"default"!==n&&Object.prototype.hasOwnProperty.call(e,n)&&i(t,e,n);return r(t,e),t};Object.defineProperty(t,"__esModule",{value:!0}),t.defaultLineByLineRendererConfig=void 0;const l=s(n(483)),a=s(n(741)),o=n(699);t.defaultLineByLineRendererConfig=Object.assign(Object.assign({},a.defaultRenderConfig),{renderNothingWhenEmpty:!1,matchingMaxComparisons:2500,maxLineSizeInBlockForComparison:200});const c="generic",d="line-by-line";t.default=class{constructor(e,n={}){this.hoganUtils=e,this.config=Object.assign(Object.assign({},t.defaultLineByLineRendererConfig),n)}render(e){const t=e.map((e=>{let t;return t=e.blocks.length?this.generateFileHtml(e):this.generateEmptyDiff(),this.makeFileDiffHtml(e,t)})).join("\n");return this.hoganUtils.render(c,"wrapper",{content:t})}makeFileDiffHtml(e,t){if(this.config.renderNothingWhenEmpty&&Array.isArray(e.blocks)&&0===e.blocks.length)return"";const n=this.hoganUtils.template(d,"file-diff"),i=this.hoganUtils.template(c,"file-path"),r=this.hoganUtils.template("icon","file"),s=this.hoganUtils.template("tag",a.getFileIcon(e));return n.render({file:e,fileHtmlId:a.getHtmlId(e),diffs:t,filePath:i.render({fileDiffName:a.filenameDiff(e)},{fileIcon:r,fileTag:s})})}generateEmptyDiff(){return this.hoganUtils.render(c,"empty-diff",{contentClass:"d2h-code-line",CSSLineClass:a.CSSLineClass})}generateFileHtml(e){const t=l.newMatcherFn(l.newDistanceFn((t=>a.deconstructLine(t.content,e.isCombined).content)));return e.blocks.map((n=>{let i=this.hoganUtils.render(c,"block-header",{CSSLineClass:a.CSSLineClass,blockHeader:e.isTooBig?n.header:a.escapeForHtml(n.header),lineClass:"d2h-code-linenumber",contentClass:"d2h-code-line"});return this.applyLineGroupping(n).forEach((([n,r,s])=>{if(r.length&&s.length&&!n.length)this.applyRematchMatching(r,s,t).map((([t,n])=>{const{left:r,right:s}=this.processChangedLines(e,e.isCombined,t,n);i+=r,i+=s}));else if(n.length)n.forEach((t=>{const{prefix:n,content:r}=a.deconstructLine(t.content,e.isCombined);i+=this.generateSingleLineHtml(e,{type:a.CSSLineClass.CONTEXT,prefix:n,content:r,oldNumber:t.oldNumber,newNumber:t.newNumber})}));else if(r.length||s.length){const{left:t,right:n}=this.processChangedLines(e,e.isCombined,r,s);i+=t,i+=n}else console.error("Unknown state reached while processing groups of lines",n,r,s)})),i})).join("\n")}applyLineGroupping(e){const t=[];let n=[],i=[];for(let r=0;r0)&&(t.push([[],n,i]),n=[],i=[]),s.type===o.LineType.CONTEXT?t.push([[s],[],[]]):s.type===o.LineType.INSERT&&0===n.length?t.push([[],[],[s]]):s.type===o.LineType.INSERT&&n.length>0?i.push(s):s.type===o.LineType.DELETE&&n.push(s)}return(n.length||i.length)&&(t.push([[],n,i]),n=[],i=[]),t}applyRematchMatching(e,t,n){const i=e.length*t.length,r=Math.max.apply(null,[0].concat(e.concat(t).map((e=>e.content.length))));return i{"use strict";function n(e,t){if(0===e.length)return t.length;if(0===t.length)return e.length;const n=[];let i,r;for(i=0;i<=t.length;i++)n[i]=[i];for(r=0;r<=e.length;r++)n[0][r]=r;for(i=1;i<=t.length;i++)for(r=1;r<=e.length;r++)t.charAt(i-1)===e.charAt(r-1)?n[i][r]=n[i-1][r-1]:n[i][r]=Math.min(n[i-1][r-1]+1,Math.min(n[i][r-1]+1,n[i-1][r]+1));return n[t.length][e.length]}Object.defineProperty(t,"__esModule",{value:!0}),t.newMatcherFn=t.newDistanceFn=t.levenshtein=void 0,t.levenshtein=n,t.newDistanceFn=function(e){return(t,i)=>{const r=e(t).trim(),s=e(i).trim();return n(r,s)/(r.length+s.length)}},t.newMatcherFn=function(e){return function t(n,i,r=0,s=new Map){const l=function(t,n,i=new Map){let r,s=1/0;for(let l=0;l0||l.indexB>0)&&(v=g.concat(v)),(n.length>f||i.length>u)&&(v=v.concat(m)),v}}},741:function(e,t,n){"use strict";var i=this&&this.__createBinding||(Object.create?function(e,t,n,i){void 0===i&&(i=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,i,r)}:function(e,t,n,i){void 0===i&&(i=n),e[i]=t[n]}),r=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var n in e)"default"!==n&&Object.prototype.hasOwnProperty.call(e,n)&&i(t,e,n);return r(t,e),t};Object.defineProperty(t,"__esModule",{value:!0}),t.diffHighlight=t.getFileIcon=t.getHtmlId=t.filenameDiff=t.deconstructLine=t.escapeForHtml=t.toCSSClass=t.defaultRenderConfig=t.CSSLineClass=void 0;const l=s(n(785)),a=n(593),o=s(n(483)),c=n(699);t.CSSLineClass={INSERTS:"d2h-ins",DELETES:"d2h-del",CONTEXT:"d2h-cntx",INFO:"d2h-info",INSERT_CHANGES:"d2h-ins d2h-change",DELETE_CHANGES:"d2h-del d2h-change"},t.defaultRenderConfig={matching:c.LineMatchingType.NONE,matchWordsThreshold:.25,maxLineLengthHighlight:1e4,diffStyle:c.DiffStyleType.WORD};const d="/",f=o.newDistanceFn((e=>e.value)),u=o.newMatcherFn(f);function p(e){return-1!==e.indexOf("dev/null")}function h(e){return e.replace(/(]*>((.|\n)*?)<\/del>)/g,"")}function g(e){return e.slice(0).replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")}function b(e,t,n=!0){const i=function(e){return e?2:1}(t);return{prefix:e.substring(0,i),content:n?g(e.substring(i)):e.substring(i)}}function m(e){const t=(0,a.unifyPath)(e.oldName),n=(0,a.unifyPath)(e.newName);if(t===n||p(t)||p(n))return p(n)?t:n;{const e=[],i=[],r=t.split(d),s=n.split(d);let l=0,a=r.length-1,o=s.length-1;for(;ll&&o>l&&r[a]===s[o];)i.unshift(s[o]),a-=1,o-=1;const c=e.join(d),f=i.join(d),u=r.slice(l,a+1).join(d),p=s.slice(l,o+1).join(d);return c.length&&f.length?c+d+"{"+u+" → "+p+"}"+d+f:c.length?c+d+"{"+u+" → "+p+"}":f.length?"{"+u+" → "+p+"}"+d+f:t+" → "+n}}t.toCSSClass=function(e){switch(e){case c.LineType.CONTEXT:return t.CSSLineClass.CONTEXT;case c.LineType.INSERT:return t.CSSLineClass.INSERTS;case c.LineType.DELETE:return t.CSSLineClass.DELETES}},t.escapeForHtml=g,t.deconstructLine=b,t.filenameDiff=m,t.getHtmlId=function(e){return`d2h-${(0,a.hashCode)(m(e)).toString().slice(-6)}`},t.getFileIcon=function(e){let t="file-changed";return e.isRename||e.isCopy?t="file-renamed":e.isNew?t="file-added":e.isDeleted?t="file-deleted":e.newName!==e.oldName&&(t="file-renamed"),t},t.diffHighlight=function(e,n,i,r={}){const{matching:s,maxLineLengthHighlight:a,matchWordsThreshold:o,diffStyle:c}=Object.assign(Object.assign({},t.defaultRenderConfig),r),d=b(e,i,!1),p=b(n,i,!1);if(d.content.length>a||p.content.length>a)return{oldLine:{prefix:d.prefix,content:g(d.content)},newLine:{prefix:p.prefix,content:g(p.content)}};const m="char"===c?l.diffChars(d.content,p.content):l.diffWordsWithSpace(d.content,p.content),v=[];if("word"===c&&"words"===s){const e=m.filter((e=>e.removed)),t=m.filter((e=>e.added));u(t,e).forEach((e=>{1===e[0].length&&1===e[1].length&&f(e[0][0],e[1][0]){const n=t.added?"ins":t.removed?"del":null,i=v.indexOf(t)>-1?' class="d2h-change"':"",r=g(t.value);return null!==n?`${e}<${n}${i}>${r}`:`${e}${r}`}),"");return{oldLine:{prefix:d.prefix,content:(w=y,w.replace(/(]*>((.|\n)*?)<\/ins>)/g,""))},newLine:{prefix:p.prefix,content:h(y)}};var w}},170:function(e,t,n){"use strict";var i=this&&this.__createBinding||(Object.create?function(e,t,n,i){void 0===i&&(i=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,i,r)}:function(e,t,n,i){void 0===i&&(i=n),e[i]=t[n]}),r=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var n in e)"default"!==n&&Object.prototype.hasOwnProperty.call(e,n)&&i(t,e,n);return r(t,e),t};Object.defineProperty(t,"__esModule",{value:!0}),t.defaultSideBySideRendererConfig=void 0;const l=s(n(483)),a=s(n(741)),o=n(699);t.defaultSideBySideRendererConfig=Object.assign(Object.assign({},a.defaultRenderConfig),{renderNothingWhenEmpty:!1,matchingMaxComparisons:2500,maxLineSizeInBlockForComparison:200});const c="generic";t.default=class{constructor(e,n={}){this.hoganUtils=e,this.config=Object.assign(Object.assign({},t.defaultSideBySideRendererConfig),n)}render(e){const t=e.map((e=>{let t;return t=e.blocks.length?this.generateFileHtml(e):this.generateEmptyDiff(),this.makeFileDiffHtml(e,t)})).join("\n");return this.hoganUtils.render(c,"wrapper",{content:t})}makeFileDiffHtml(e,t){if(this.config.renderNothingWhenEmpty&&Array.isArray(e.blocks)&&0===e.blocks.length)return"";const n=this.hoganUtils.template("side-by-side","file-diff"),i=this.hoganUtils.template(c,"file-path"),r=this.hoganUtils.template("icon","file"),s=this.hoganUtils.template("tag",a.getFileIcon(e));return n.render({file:e,fileHtmlId:a.getHtmlId(e),diffs:t,filePath:i.render({fileDiffName:a.filenameDiff(e)},{fileIcon:r,fileTag:s})})}generateEmptyDiff(){return{right:"",left:this.hoganUtils.render(c,"empty-diff",{contentClass:"d2h-code-side-line",CSSLineClass:a.CSSLineClass})}}generateFileHtml(e){const t=l.newMatcherFn(l.newDistanceFn((t=>a.deconstructLine(t.content,e.isCombined).content)));return e.blocks.map((n=>{const i={left:this.makeHeaderHtml(n.header,e),right:this.makeHeaderHtml("")};return this.applyLineGroupping(n).forEach((([n,r,s])=>{if(r.length&&s.length&&!n.length)this.applyRematchMatching(r,s,t).map((([t,n])=>{const{left:r,right:s}=this.processChangedLines(e.isCombined,t,n);i.left+=r,i.right+=s}));else if(n.length)n.forEach((t=>{const{prefix:n,content:r}=a.deconstructLine(t.content,e.isCombined),{left:s,right:l}=this.generateLineHtml({type:a.CSSLineClass.CONTEXT,prefix:n,content:r,number:t.oldNumber},{type:a.CSSLineClass.CONTEXT,prefix:n,content:r,number:t.newNumber});i.left+=s,i.right+=l}));else if(r.length||s.length){const{left:t,right:n}=this.processChangedLines(e.isCombined,r,s);i.left+=t,i.right+=n}else console.error("Unknown state reached while processing groups of lines",n,r,s)})),i})).reduce(((e,t)=>({left:e.left+t.left,right:e.right+t.right})),{left:"",right:""})}applyLineGroupping(e){const t=[];let n=[],i=[];for(let r=0;r0)&&(t.push([[],n,i]),n=[],i=[]),s.type===o.LineType.CONTEXT?t.push([[s],[],[]]):s.type===o.LineType.INSERT&&0===n.length?t.push([[],[],[s]]):s.type===o.LineType.INSERT&&n.length>0?i.push(s):s.type===o.LineType.DELETE&&n.push(s)}return(n.length||i.length)&&(t.push([[],n,i]),n=[],i=[]),t}applyRematchMatching(e,t,n){const i=e.length*t.length,r=Math.max.apply(null,[0].concat(e.concat(t).map((e=>e.content.length))));return i{"use strict";var n;Object.defineProperty(t,"__esModule",{value:!0}),t.DiffStyleType=t.LineMatchingType=t.OutputFormatType=t.LineType=void 0,function(e){e.INSERT="insert",e.DELETE="delete",e.CONTEXT="context"}(n||(t.LineType=n={})),t.OutputFormatType={LINE_BY_LINE:"line-by-line",SIDE_BY_SIDE:"side-by-side"},t.LineMatchingType={LINES:"lines",WORDS:"words",NONE:"none"},t.DiffStyleType={WORD:"word",CHAR:"char"}},169:(e,t,n)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.Diff2HtmlUI=t.defaultDiff2HtmlUIConfig=void 0;const i=n(529),r=n(834);t.defaultDiff2HtmlUIConfig=Object.assign(Object.assign({},r.defaultDiff2HtmlConfig),{synchronisedScroll:!0,highlight:!0,fileListToggle:!0,fileListStartVisible:!1,highlightLanguages:new Map,smartSelection:!0,fileContentToggle:!0,stickyFileHeaders:!0}),t.Diff2HtmlUI=class{constructor(e,n,i={},s){this.hljs=null,this.currentSelectionColumnId=-1,this.config=Object.assign(Object.assign({},t.defaultDiff2HtmlUIConfig),i),this.diffHtml=void 0!==n?(0,r.html)(n,this.config):e.innerHTML,this.targetElement=e,void 0!==s&&(this.hljs=s)}draw(){this.targetElement.innerHTML=this.diffHtml,this.config.synchronisedScroll&&this.synchronisedScroll(),this.config.highlight&&this.highlightCode(),this.config.fileListToggle&&this.fileListToggle(this.config.fileListStartVisible),this.config.fileContentToggle&&this.fileContentToggle(),this.config.stickyFileHeaders&&this.stickyFileHeaders()}synchronisedScroll(){this.targetElement.querySelectorAll(".d2h-file-wrapper").forEach((e=>{const[t,n]=Array().slice.call(e.querySelectorAll(".d2h-file-side-diff"));if(void 0===t||void 0===n)return;const i=e=>{null!==e&&null!==e.target&&(e.target===t?(n.scrollTop=t.scrollTop,n.scrollLeft=t.scrollLeft):(t.scrollTop=n.scrollTop,t.scrollLeft=n.scrollLeft))};t.addEventListener("scroll",i),n.addEventListener("scroll",i)}))}fileListToggle(e){const t=this.targetElement.querySelector(".d2h-show"),n=this.targetElement.querySelector(".d2h-hide"),i=this.targetElement.querySelector(".d2h-file-list");if(null===t||null===n||null===i)return;const r=()=>{t.style.display="none",n.style.display="inline",i.style.display="block"},s=()=>{t.style.display="inline",n.style.display="none",i.style.display="none"};t.addEventListener("click",(()=>r())),n.addEventListener("click",(()=>s()));const l=this.getHashTag();"files-summary-show"===l?r():"files-summary-hide"===l?s():e?r():s()}fileContentToggle(){this.targetElement.querySelectorAll(".d2h-file-collapse").forEach((e=>{e.style.display="flex";const t=t=>{var n;const i=null===(n=e.closest(".d2h-file-wrapper"))||void 0===n?void 0:n.querySelector(t);null!=i&&(e.classList.toggle("d2h-selected"),i.classList.toggle("d2h-d-none"))};e.addEventListener("click",(n=>(n=>{e!==n.target&&(t(".d2h-file-diff"),t(".d2h-files-diff"))})(n)))}))}highlightCode(){const e=this.hljs;if(null===e)throw new Error("Missing a `highlight.js` implementation. Please provide one when instantiating Diff2HtmlUI.");this.targetElement.querySelectorAll(".d2h-file-wrapper").forEach((t=>{const n=t.getAttribute("data-lang");this.config.highlightLanguages instanceof Map||(this.config.highlightLanguages=new Map(Object.entries(this.config.highlightLanguages)));let r=n&&this.config.highlightLanguages.has(n)?this.config.highlightLanguages.get(n):n?(0,i.getLanguage)(n):"plaintext";void 0===e.getLanguage(r)&&(r="plaintext"),t.querySelectorAll(".d2h-code-line-ctn").forEach((t=>{const n=t.textContent,s=t.parentNode;if(null===n||null===s||!this.isElement(s))return;const l=(0,i.closeTags)(e.highlight(n,{language:r,ignoreIllegals:!0})),a=(0,i.nodeStream)(t);if(a.length){const e=document.createElementNS("http://www.w3.org/1999/xhtml","div");e.innerHTML=l.value,l.value=(0,i.mergeStreams)(a,(0,i.nodeStream)(e),n)}t.classList.add("hljs"),l.language&&t.classList.add(l.language),t.innerHTML=l.value}))}))}stickyFileHeaders(){this.targetElement.querySelectorAll(".d2h-file-header").forEach((e=>{e.classList.add("d2h-sticky-header")}))}smartSelection(){console.warn("Smart selection is now enabled by default with CSS. No need to call this method anymore.")}getHashTag(){const e=document.URL,t=e.indexOf("#");let n=null;return-1!==t&&(n=e.substr(t+1)),n}isElement(e){return null!==e&&void 0!==(null==e?void 0:e.classList)}}},529:(e,t)=>{"use strict";function n(e){return e.replace(/&/gm,"&").replace(//gm,">")}function i(e){return e.nodeName.toLowerCase()}Object.defineProperty(t,"__esModule",{value:!0}),t.getLanguage=t.closeTags=t.mergeStreams=t.nodeStream=void 0,t.nodeStream=function(e){const t=[],n=(e,r)=>{for(let s=e.firstChild;s;s=s.nextSibling)3===s.nodeType&&null!==s.nodeValue?r+=s.nodeValue.length:1===s.nodeType&&(t.push({event:"start",offset:r,node:s}),r=n(s,r),i(s).match(/br|hr|img|input/)||t.push({event:"stop",offset:r,node:s}));return r};return n(e,0),t},t.mergeStreams=function(e,t,r){let s=0,l="";const a=[];function o(){return e.length&&t.length?e[0].offset!==t[0].offset?e[0].offset`${e.nodeName}="${n(e.value).replace(/"/g,""")}"`)).join(" ")}>`}function d(e){l+=""}function f(e){("start"===e.event?c:d)(e.node)}for(;e.length||t.length;){let t=o();if(l+=n(r.substring(s,t[0].offset)),s=t[0].offset,t===e){a.reverse().forEach(d);do{f(t.splice(0,1)[0]),t=o()}while(t===e&&t.length&&t[0].offset===s);a.reverse().forEach(c)}else"start"===t[0].event?a.push(t[0].node):a.pop(),f(t.splice(0,1)[0])}return l+n(r.substr(s))},t.closeTags=function(e){const t=new Array;return e.value=e.value.split("\n").map((e=>{const n=t.map((e=>``)).join(""),i=e.matchAll(/(|<\/span>)/g);return Array.from(i).forEach((e=>{""===e[0]?t.shift():t.unshift(e[2])})),n+e+"".repeat(t.length)})).join("\n"),e};const r={"1c":"1c",abnf:"abnf",accesslog:"accesslog",as:"actionscript",adb:"ada",ada:"ada",ads:"ada",angelscript:"angelscript",apache:"apache",applescript:"applescript",scpt:"applescript",arcade:"arcade",cpp:"cpp",hpp:"cpp",arduino:"arduino",ino:"arduino",armasm:"armasm",arm:"armasm",xml:"xml",html:"xml",xhtml:"xml",rss:"xml",atom:"xml",xjb:"xml",xsd:"xml",xsl:"xml",plist:"xml",svg:"xml",asciidoc:"asciidoc",adoc:"asciidoc",asc:"asciidoc",aspectj:"aspectj",ahk:"autohotkey",ahkl:"autohotkey",au3:"autoit",avrasm:"avrasm",awk:"awk",axapta:"axapta","x++":"axapta",bash:"bash",sh:"bash",zsh:"bash",b:"basic",bnf:"bnf",bf:"brainfuck",c:"c",h:"c",cats:"c",idc:"c",cal:"cal",capnproto:"capnproto",capnp:"capnproto",ceylon:"ceylon",clean:"clean",clj:"clojure",boot:"clojure",cl2:"clojure",cljc:"clojure",cljs:"clojure","cljs.hl":"clojure",cljscm:"clojure",cljx:"clojure",hic:"clojure","clojure-repl":"clojure-repl",cmake:"cmake","cmake.in":"cmake",coffee:"coffeescript",_coffee:"coffeescript",cake:"coffeescript",cjsx:"coffeescript",iced:"coffeescript",cson:"coffeescript",coq:"coq",cos:"cos",cls:"cos",crmsh:"crmsh",crm:"crmsh",pcmk:"crmsh",cr:"crystal",cs:"csharp",csx:"csharp",csp:"csp",css:"css",d:"d",di:"d",md:"markdown",markdown:"markdown",mdown:"markdown",mdwn:"markdown",mkd:"markdown",mkdn:"markdown",mkdown:"markdown",ronn:"markdown",workbook:"markdown",dart:"dart",dpr:"delphi",dfm:"delphi",pas:"delphi",pascal:"delphi",diff:"diff",patch:"diff",django:"django",jinja:"django",dns:"dns",zone:"dns",bind:"dns",dockerfile:"dockerfile",docker:"dockerfile",dos:"dos",bat:"dos",cmd:"dos",dsconfig:"dsconfig",dts:"dts",dust:"dust",dst:"dust",ebnf:"ebnf",ex:"elixir",exs:"elixir",elm:"elm",rb:"ruby",builder:"ruby",eye:"ruby",gemspec:"ruby",god:"ruby",jbuilder:"ruby",mspec:"ruby",pluginspec:"ruby",podspec:"ruby",rabl:"ruby",rake:"ruby",rbuild:"ruby",rbw:"ruby",rbx:"ruby",ru:"ruby",ruby:"ruby",spec:"ruby",thor:"ruby",watchr:"ruby",erb:"erb","erlang-repl":"erlang-repl",erl:"erlang","app.src":"erlang",escript:"erlang",hrl:"erlang",xrl:"erlang",yrl:"erlang",excel:"excel",xls:"excel",xlsx:"excel",fix:"fix",flix:"flix",f90:"fortran",f:"fortran",f03:"fortran",f08:"fortran",f77:"fortran",f95:"fortran",for:"fortran",fpp:"fortran",fs:"fsharp",fsx:"fsharp",gams:"gams",gms:"gams",gauss:"gauss",gss:"gauss",gcode:"gcode",nc:"gcode",gherkin:"gherkin",glsl:"glsl",fp:"glsl",frag:"glsl",frg:"glsl",fsh:"glsl",fshader:"glsl",geo:"glsl",geom:"glsl",glslv:"glsl",gshader:"glsl",shader:"glsl",tesc:"glsl",tese:"glsl",vert:"glsl",vrx:"glsl",vsh:"glsl",vshader:"glsl",gml:"gml",go:"go",bal:"go",golo:"golo",gololang:"golo",gradle:"gradle",groovy:"groovy",grt:"groovy",gtpl:"groovy",gvy:"groovy",haml:"haml","haml.deface":"haml",handlebars:"handlebars",hbs:"handlebars","html.hbs":"handlebars","html.handlebars":"handlebars",hs:"haskell",hsc:"haskell",idr:"haskell",purs:"haskell",hx:"haxe",hxsl:"haxe",hsp:"hsp",htmlbars:"htmlbars",http:"http",https:"http",hy:"hy",inform7:"inform7",i7:"inform7",ini:"ini",toml:"ini",cfg:"ini",prefs:"ini",irpf90:"irpf90",isbl:"isbl",java:"java",jsp:"java",js:"javascript",jsx:"javascript",_js:"javascript",bones:"javascript",es:"javascript",es6:"javascript",gs:"javascript",jake:"javascript",jsb:"javascript",jscad:"javascript",jsfl:"javascript",jsm:"javascript",jss:"javascript",mjs:"javascript",njs:"javascript",pac:"javascript",sjs:"javascript",ssjs:"javascript",xsjs:"javascript",xsjslib:"javascript",cfc:"javascript","jboss-cli":"jboss-cli",json:"json",avsc:"json",geojson:"json",gltf:"json","JSON-tmLanguage":"json",jsonl:"json",tfstate:"json","tfstate.backup":"json",topojson:"json",webapp:"json",webmanifest:"json",jl:"julia","julia-repl":"julia-repl",kt:"kotlin",ktm:"kotlin",kts:"kotlin",lasso:"lasso",lassoscript:"lasso",tex:"latex",ldif:"ldif",leaf:"leaf",less:"less",lisp:"lisp",factor:"lisp",livecodeserver:"livecodeserver",ls:"livescript",_ls:"livescript",llvm:"llvm",lsl:"lsl",lua:"lua",nse:"lua",p8:"lua",pd_lua:"lua",rbxs:"lua",wlua:"lua",mak:"makefile",make:"makefile",mk:"makefile",mkfile:"makefile",mathematica:"mathematica",mma:"mathematica",wl:"mathematica",matlab:"matlab",maxima:"maxima",mel:"mel",mercury:"mercury",mipsasm:"mipsasm",miz:"mizar",voc:"mizar",al:"perl",cgi:"perl",fcgi:"perl",perl:"perl",ph:"perl",plx:"perl",pl:"perl",pm:"perl",psgi:"perl",t:"perl",mojolicious:"mojolicious",monkey:"monkey",monkey2:"monkey",moonscript:"moonscript",moon:"moonscript",n1ql:"n1ql",nginxconf:"nginx",nim:"nim",nimrod:"nim",nix:"nix",nsi:"nsis",nsh:"nsis",m:"objectivec",objc:"objectivec",mm:"objectivec","obj-c":"objectivec","obj-c++":"objectivec","objective-c++":"objectivec",fun:"ocaml",sig:"ocaml",ml:"ocaml",mli:"ocaml",eliom:"ocaml",eliomi:"ocaml",ml4:"ocaml",mll:"ocaml",mly:"ocaml",openscad:"openscad",oxygene:"oxygene",parser3:"parser3",pf:"pf","pf.conf":"pf",pgsql:"pgsql",postgres:"pgsql",postgresql:"pgsql",php:"php",aw:"php",ctp:"php",inc:"php",php3:"php",php4:"php",php5:"php",phps:"php",phpt:"php","php-template":"php-template",plaintext:"plaintext",txt:"plaintext",text:"plaintext",pony:"pony",ps:"powershell",ps1:"powershell",psd1:"powershell",psm1:"powershell",pde:"processing",profile:"profile",pro:"prolog",prolog:"prolog",yap:"prolog",properties:"properties",proto:"protobuf",puppet:"puppet",pp:"puppet",purebasic:"purebasic",py:"python",bzl:"python",gyp:"python",gypi:"python",lmi:"python",py3:"python",pyde:"python",pyi:"python",pyp:"python",pyt:"python",pyw:"python",rpy:"python",tac:"python",wsgi:"python",xpy:"python","python-repl":"python-repl",pycon:"python-repl",q:"q",k:"q",kdb:"q",qml:"qml",r:"r",rd:"r",rsx:"r",reasonml:"reasonml",re:"reasonml",rib:"rib",roboconf:"roboconf",graph:"roboconf",instances:"roboconf",routeros:"routeros",rsl:"rsl",ruleslanguage:"ruleslanguage",rs:"rust","rs.in":"rust",sas:"sas",scala:"scala",kojo:"scala",sbt:"scala",sc:"scala",scm:"scheme",sch:"scheme",sld:"scheme",sls:"scheme",sps:"scheme",ss:"scheme",rkt:"scheme",scilab:"scilab",scss:"scss",shell:"shell",smali:"smali",st:"smalltalk",sml:"sml",sqf:"sqf",sql:"sql",cql:"sql",ddl:"sql",mysql:"sql",prc:"sql",tab:"sql",udf:"sql",viw:"sql",stan:"stan",stanfuncs:"stan",stata:"stata",step21:"step21",step:"step21",stp:"step21",styl:"stylus",subunit:"subunit",swift:"swift",taggerscript:"taggerscript",yml:"yaml",mir:"yaml",reek:"yaml",rviz:"yaml","sublime-syntax":"yaml",syntax:"yaml",yaml:"yaml","yaml-tmlanguage":"yaml","yml.mysql":"yaml",tap:"tap",tcl:"tcl",adp:"tcl",tm:"tcl",thrift:"thrift",tp:"tp",twig:"twig",craftcms:"twig",ts:"typescript",tsx:"typescript",vala:"vala",vbnet:"vbnet",vb:"vbnet",vbscript:"vbscript",vbs:"vbscript","vbscript-html":"vbscript-html",v:"verilog",veo:"verilog",vhdl:"vhdl",vhd:"vhdl",vhf:"vhdl",vhi:"vhdl",vho:"vhdl",vhs:"vhdl",vht:"vhdl",vhw:"vhdl",vim:"vim",x86asm:"x86asm",xl:"xl",xquery:"xquery",xpath:"xquery",xq:"xquery",zephir:"zephir",zep:"zephir"};t.getLanguage=function(e){var t;return null!==(t=r[e])&&void 0!==t?t:"plaintext"}},593:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.hashCode=t.unifyPath=t.escapeForRegExp=void 0;const n=RegExp("["+["-","[","]","/","{","}","(",")","*","+","?",".","\\","^","$","|"].join("\\")+"]","g");t.escapeForRegExp=function(e){return e.replace(n,"\\$&")},t.unifyPath=function(e){return e?e.replace(/\\/g,"/"):e},t.hashCode=function(e){let t,n,i,r=0;for(t=0,i=e.length;t li {
- border-bottom: 1px solid #ddd;
- margin: 0;
- padding: 5px 10px
-}
-
-.d2h-file-list > li:last-child {
- border-bottom: none
-}
-
-.d2h-file-switch {
- cursor: pointer;
- display: none;
- font-size: 10px
-}
-
-.d2h-icon {
- fill: currentColor;
- margin-right: 10px;
- vertical-align: middle
-}
-
-.d2h-deleted {
- color: #c33
-}
-
-.d2h-added {
- color: #399839
-}
-
-.d2h-changed {
- color: #d0b44c
-}
-
-.d2h-moved {
- color: #3572b0
-}
-
-.d2h-tag {
- background-color: var(--bg);
- display: -webkit-box;
- display: -ms-flexbox;
- display: flex;
- font-size: 10px;
- margin-left: 5px;
- padding: 0 2px
-}
-
-.d2h-deleted-tag {
- border: 1px solid #c33
-}
-
-.d2h-added-tag {
- border: 1px solid #399839
-}
-
-.d2h-changed-tag {
- border: 1px solid #d0b44c
-}
-
-.d2h-moved-tag {
- border: 1px solid #3572b0
-}
diff --git a/tutorial/mdbook-admonish.css b/tutorial/mdbook-admonish.css
deleted file mode 100644
index e0a3365..0000000
--- a/tutorial/mdbook-admonish.css
+++ /dev/null
@@ -1,341 +0,0 @@
-@charset "UTF-8";
-:root {
- --md-admonition-icon--admonish-note: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-abstract: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-info: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-tip: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-success: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-question: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-warning: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-failure: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-danger: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-bug: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-example: url("data:image/svg+xml;charset=utf-8,");
- --md-admonition-icon--admonish-quote: url("data:image/svg+xml;charset=utf-8,");
- --md-details-icon: url("data:image/svg+xml;charset=utf-8,");
-}
-
-:is(.admonition) {
- display: flow-root;
- margin: 1.5625em 0;
- padding: 0 1.2rem;
- color: var(--fg);
- page-break-inside: avoid;
- background-color: var(--bg);
- border: 0 solid black;
- border-inline-start-width: 0.4rem;
- border-radius: 0.2rem;
- box-shadow: 0 0.2rem 1rem rgba(0, 0, 0, 0.05), 0 0 0.1rem rgba(0, 0, 0, 0.1);
-}
-@media print {
- :is(.admonition) {
- box-shadow: none;
- }
-}
-:is(.admonition) > * {
- box-sizing: border-box;
-}
-:is(.admonition) :is(.admonition) {
- margin-top: 1em;
- margin-bottom: 1em;
-}
-:is(.admonition) > .tabbed-set:only-child {
- margin-top: 0;
-}
-html :is(.admonition) > :last-child {
- margin-bottom: 1.2rem;
-}
-
-a.admonition-anchor-link {
- display: none;
- position: absolute;
- left: -1.2rem;
- padding-right: 1rem;
-}
-a.admonition-anchor-link:link, a.admonition-anchor-link:visited {
- color: var(--fg);
-}
-a.admonition-anchor-link:link:hover, a.admonition-anchor-link:visited:hover {
- text-decoration: none;
-}
-a.admonition-anchor-link::before {
- content: "§";
-}
-
-:is(.admonition-title, summary.admonition-title) {
- position: relative;
- min-height: 4rem;
- margin-block: 0;
- margin-inline: -1.6rem -1.2rem;
- padding-block: 0.8rem;
- padding-inline: 4.4rem 1.2rem;
- font-weight: 700;
- background-color: rgba(68, 138, 255, 0.1);
- display: flex;
-}
-:is(.admonition-title, summary.admonition-title) p {
- margin: 0;
-}
-html :is(.admonition-title, summary.admonition-title):last-child {
- margin-bottom: 0;
-}
-:is(.admonition-title, summary.admonition-title)::before {
- position: absolute;
- top: 0.625em;
- inset-inline-start: 1.6rem;
- width: 2rem;
- height: 2rem;
- background-color: #448aff;
- mask-image: url('data:image/svg+xml;charset=utf-8,');
- -webkit-mask-image: url('data:image/svg+xml;charset=utf-8,');
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-size: contain;
- content: "";
-}
-:is(.admonition-title, summary.admonition-title):hover a.admonition-anchor-link {
- display: initial;
-}
-
-details.admonition > summary.admonition-title::after {
- position: absolute;
- top: 0.625em;
- inset-inline-end: 1.6rem;
- height: 2rem;
- width: 2rem;
- background-color: currentcolor;
- mask-image: var(--md-details-icon);
- -webkit-mask-image: var(--md-details-icon);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-size: contain;
- content: "";
- transform: rotate(0deg);
- transition: transform 0.25s;
-}
-details[open].admonition > summary.admonition-title::after {
- transform: rotate(90deg);
-}
-
-:is(.admonition):is(.admonish-note) {
- border-color: #448aff;
-}
-
-:is(.admonish-note) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(68, 138, 255, 0.1);
-}
-:is(.admonish-note) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #448aff;
- mask-image: var(--md-admonition-icon--admonish-note);
- -webkit-mask-image: var(--md-admonition-icon--admonish-note);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-abstract, .admonish-summary, .admonish-tldr) {
- border-color: #00b0ff;
-}
-
-:is(.admonish-abstract, .admonish-summary, .admonish-tldr) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(0, 176, 255, 0.1);
-}
-:is(.admonish-abstract, .admonish-summary, .admonish-tldr) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #00b0ff;
- mask-image: var(--md-admonition-icon--admonish-abstract);
- -webkit-mask-image: var(--md-admonition-icon--admonish-abstract);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-info, .admonish-todo) {
- border-color: #00b8d4;
-}
-
-:is(.admonish-info, .admonish-todo) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(0, 184, 212, 0.1);
-}
-:is(.admonish-info, .admonish-todo) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #00b8d4;
- mask-image: var(--md-admonition-icon--admonish-info);
- -webkit-mask-image: var(--md-admonition-icon--admonish-info);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-tip, .admonish-hint, .admonish-important) {
- border-color: #00bfa5;
-}
-
-:is(.admonish-tip, .admonish-hint, .admonish-important) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(0, 191, 165, 0.1);
-}
-:is(.admonish-tip, .admonish-hint, .admonish-important) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #00bfa5;
- mask-image: var(--md-admonition-icon--admonish-tip);
- -webkit-mask-image: var(--md-admonition-icon--admonish-tip);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-success, .admonish-check, .admonish-done) {
- border-color: #00c853;
-}
-
-:is(.admonish-success, .admonish-check, .admonish-done) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(0, 200, 83, 0.1);
-}
-:is(.admonish-success, .admonish-check, .admonish-done) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #00c853;
- mask-image: var(--md-admonition-icon--admonish-success);
- -webkit-mask-image: var(--md-admonition-icon--admonish-success);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-question, .admonish-help, .admonish-faq) {
- border-color: #64dd17;
-}
-
-:is(.admonish-question, .admonish-help, .admonish-faq) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(100, 221, 23, 0.1);
-}
-:is(.admonish-question, .admonish-help, .admonish-faq) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #64dd17;
- mask-image: var(--md-admonition-icon--admonish-question);
- -webkit-mask-image: var(--md-admonition-icon--admonish-question);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-warning, .admonish-caution, .admonish-attention) {
- border-color: #ff9100;
-}
-
-:is(.admonish-warning, .admonish-caution, .admonish-attention) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(255, 145, 0, 0.1);
-}
-:is(.admonish-warning, .admonish-caution, .admonish-attention) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #ff9100;
- mask-image: var(--md-admonition-icon--admonish-warning);
- -webkit-mask-image: var(--md-admonition-icon--admonish-warning);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-failure, .admonish-fail, .admonish-missing) {
- border-color: #ff5252;
-}
-
-:is(.admonish-failure, .admonish-fail, .admonish-missing) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(255, 82, 82, 0.1);
-}
-:is(.admonish-failure, .admonish-fail, .admonish-missing) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #ff5252;
- mask-image: var(--md-admonition-icon--admonish-failure);
- -webkit-mask-image: var(--md-admonition-icon--admonish-failure);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-danger, .admonish-error) {
- border-color: #ff1744;
-}
-
-:is(.admonish-danger, .admonish-error) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(255, 23, 68, 0.1);
-}
-:is(.admonish-danger, .admonish-error) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #ff1744;
- mask-image: var(--md-admonition-icon--admonish-danger);
- -webkit-mask-image: var(--md-admonition-icon--admonish-danger);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-bug) {
- border-color: #f50057;
-}
-
-:is(.admonish-bug) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(245, 0, 87, 0.1);
-}
-:is(.admonish-bug) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #f50057;
- mask-image: var(--md-admonition-icon--admonish-bug);
- -webkit-mask-image: var(--md-admonition-icon--admonish-bug);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-example) {
- border-color: #7c4dff;
-}
-
-:is(.admonish-example) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(124, 77, 255, 0.1);
-}
-:is(.admonish-example) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #7c4dff;
- mask-image: var(--md-admonition-icon--admonish-example);
- -webkit-mask-image: var(--md-admonition-icon--admonish-example);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-:is(.admonition):is(.admonish-quote, .admonish-cite) {
- border-color: #9e9e9e;
-}
-
-:is(.admonish-quote, .admonish-cite) > :is(.admonition-title, summary.admonition-title) {
- background-color: rgba(158, 158, 158, 0.1);
-}
-:is(.admonish-quote, .admonish-cite) > :is(.admonition-title, summary.admonition-title)::before {
- background-color: #9e9e9e;
- mask-image: var(--md-admonition-icon--admonish-quote);
- -webkit-mask-image: var(--md-admonition-icon--admonish-quote);
- mask-repeat: no-repeat;
- -webkit-mask-repeat: no-repeat;
- mask-size: contain;
- -webkit-mask-repeat: no-repeat;
-}
-
-.navy :is(.admonition) {
- background-color: var(--sidebar-bg);
-}
-
-.ayu :is(.admonition),
-.coal :is(.admonition) {
- background-color: var(--theme-hover);
-}
-
-.rust :is(.admonition) {
- background-color: var(--sidebar-bg);
- color: var(--sidebar-fg);
-}
-.rust .admonition-anchor-link:link, .rust .admonition-anchor-link:visited {
- color: var(--sidebar-fg);
-}
diff --git a/tutorial/mdbook-diff2html/.gitignore b/tutorial/mdbook-diff2html/.gitignore
deleted file mode 100644
index 2ee0272..0000000
--- a/tutorial/mdbook-diff2html/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-# Rust
-/target
diff --git a/tutorial/mdbook-diff2html/Cargo.lock b/tutorial/mdbook-diff2html/Cargo.lock
deleted file mode 100644
index c387f9d..0000000
--- a/tutorial/mdbook-diff2html/Cargo.lock
+++ /dev/null
@@ -1,920 +0,0 @@
-# This file is automatically @generated by Cargo.
-# It is not intended for manual editing.
-version = 3
-
-[[package]]
-name = "aho-corasick"
-version = "1.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ea5d730647d4fadd988536d06fecce94b7b4f2a7efdae548f1cf4b63205518ab"
-dependencies = [
- "memchr",
-]
-
-[[package]]
-name = "android-tzdata"
-version = "0.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e999941b234f3131b00bc13c22d06e8c5ff726d1b6318ac7eb276997bbb4fef0"
-
-[[package]]
-name = "android_system_properties"
-version = "0.1.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311"
-dependencies = [
- "libc",
-]
-
-[[package]]
-name = "anstream"
-version = "0.5.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1f58811cfac344940f1a400b6e6231ce35171f614f26439e80f8c1465c5cc0c"
-dependencies = [
- "anstyle",
- "anstyle-parse",
- "anstyle-query",
- "anstyle-wincon",
- "colorchoice",
- "utf8parse",
-]
-
-[[package]]
-name = "anstyle"
-version = "1.0.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b84bf0a05bbb2a83e5eb6fa36bb6e87baa08193c35ff52bbf6b38d8af2890e46"
-
-[[package]]
-name = "anstyle-parse"
-version = "0.2.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "938874ff5980b03a87c5524b3ae5b59cf99b1d6bc836848df7bc5ada9643c333"
-dependencies = [
- "utf8parse",
-]
-
-[[package]]
-name = "anstyle-query"
-version = "1.0.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5ca11d4be1bab0c8bc8734a9aa7bf4ee8316d462a08c6ac5052f888fef5b494b"
-dependencies = [
- "windows-sys",
-]
-
-[[package]]
-name = "anstyle-wincon"
-version = "2.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "58f54d10c6dfa51283a066ceab3ec1ab78d13fae00aa49243a45e4571fb79dfd"
-dependencies = [
- "anstyle",
- "windows-sys",
-]
-
-[[package]]
-name = "anyhow"
-version = "1.0.75"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a4668cab20f66d8d020e1fbc0ebe47217433c1b6c8f2040faf858554e394ace6"
-
-[[package]]
-name = "autocfg"
-version = "1.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
-
-[[package]]
-name = "bitflags"
-version = "1.3.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
-
-[[package]]
-name = "bitflags"
-version = "2.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b4682ae6287fcf752ecaabbfcc7b6f9b72aa33933dc23a554d853aea8eea8635"
-
-[[package]]
-name = "block-buffer"
-version = "0.10.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71"
-dependencies = [
- "generic-array",
-]
-
-[[package]]
-name = "bstr"
-version = "1.6.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4c2f7349907b712260e64b0afe2f84692af14a454be26187d9df565c7f69266a"
-dependencies = [
- "memchr",
- "regex-automata",
- "serde",
-]
-
-[[package]]
-name = "bumpalo"
-version = "3.14.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7f30e7476521f6f8af1a1c4c0b8cc94f0bee37d91763d0ca2665f299b6cd8aec"
-
-[[package]]
-name = "cc"
-version = "1.0.83"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f1174fb0b6ec23863f8b971027804a42614e347eafb0a95bf0b12cdae21fc4d0"
-dependencies = [
- "libc",
-]
-
-[[package]]
-name = "cfg-if"
-version = "1.0.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
-
-[[package]]
-name = "chrono"
-version = "0.4.31"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7f2c685bad3eb3d45a01354cedb7d5faa66194d1d58ba6e267a8de788f79db38"
-dependencies = [
- "android-tzdata",
- "iana-time-zone",
- "num-traits",
- "windows-targets",
-]
-
-[[package]]
-name = "clap"
-version = "4.4.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1d7b8d5ec32af0fadc644bf1fd509a688c2103b185644bb1e29d164e0703136"
-dependencies = [
- "clap_builder",
-]
-
-[[package]]
-name = "clap_builder"
-version = "4.4.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5179bb514e4d7c2051749d8fcefa2ed6d06a9f4e6d69faf3805f5d80b8cf8d56"
-dependencies = [
- "anstream",
- "anstyle",
- "clap_lex",
- "strsim",
- "terminal_size",
-]
-
-[[package]]
-name = "clap_complete"
-version = "4.4.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4110a1e6af615a9e6d0a36f805d5c99099f8bab9b8042f5bc1fa220a4a89e36f"
-dependencies = [
- "clap",
-]
-
-[[package]]
-name = "clap_lex"
-version = "0.5.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cd7cc57abe963c6d3b9d8be5b06ba7c8957a930305ca90304f24ef040aa6f961"
-
-[[package]]
-name = "colorchoice"
-version = "1.0.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7"
-
-[[package]]
-name = "core-foundation-sys"
-version = "0.8.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e496a50fda8aacccc86d7529e2c1e0892dbd0f898a6b5645b5561b89c3210efa"
-
-[[package]]
-name = "cpufeatures"
-version = "0.2.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a17b76ff3a4162b0b27f354a0c87015ddad39d35f9c0c36607a3bdd175dde1f1"
-dependencies = [
- "libc",
-]
-
-[[package]]
-name = "crypto-common"
-version = "0.1.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3"
-dependencies = [
- "generic-array",
- "typenum",
-]
-
-[[package]]
-name = "digest"
-version = "0.10.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
-dependencies = [
- "block-buffer",
- "crypto-common",
-]
-
-[[package]]
-name = "env_logger"
-version = "0.10.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "85cdab6a89accf66733ad5a1693a4dcced6aeff64602b634530dd73c1f3ee9f0"
-dependencies = [
- "humantime",
- "is-terminal",
- "log",
- "regex",
- "termcolor",
-]
-
-[[package]]
-name = "errno"
-version = "0.3.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "136526188508e25c6fef639d7927dfb3e0e3084488bf202267829cf7fc23dbdd"
-dependencies = [
- "errno-dragonfly",
- "libc",
- "windows-sys",
-]
-
-[[package]]
-name = "errno-dragonfly"
-version = "0.1.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "aa68f1b12764fab894d2755d2518754e71b4fd80ecfb822714a1206c2aab39bf"
-dependencies = [
- "cc",
- "libc",
-]
-
-[[package]]
-name = "fastrand"
-version = "2.0.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6999dc1837253364c2ebb0704ba97994bd874e8f195d665c50b7548f6ea92764"
-
-[[package]]
-name = "generic-array"
-version = "0.14.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a"
-dependencies = [
- "typenum",
- "version_check",
-]
-
-[[package]]
-name = "handlebars"
-version = "4.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c39b3bc2a8f715298032cf5087e58573809374b08160aa7d750582bdb82d2683"
-dependencies = [
- "log",
- "pest",
- "pest_derive",
- "serde",
- "serde_json",
- "thiserror",
-]
-
-[[package]]
-name = "hermit-abi"
-version = "0.3.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d77f7ec81a6d05a3abb01ab6eb7590f6083d08449fe5a1c8b1e620283546ccb7"
-
-[[package]]
-name = "humantime"
-version = "2.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"
-
-[[package]]
-name = "iana-time-zone"
-version = "0.1.57"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2fad5b825842d2b38bd206f3e81d6957625fd7f0a361e345c30e01a0ae2dd613"
-dependencies = [
- "android_system_properties",
- "core-foundation-sys",
- "iana-time-zone-haiku",
- "js-sys",
- "wasm-bindgen",
- "windows",
-]
-
-[[package]]
-name = "iana-time-zone-haiku"
-version = "0.1.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f"
-dependencies = [
- "cc",
-]
-
-[[package]]
-name = "is-terminal"
-version = "0.4.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cb0889898416213fab133e1d33a0e5858a48177452750691bde3666d0fdbaf8b"
-dependencies = [
- "hermit-abi",
- "rustix",
- "windows-sys",
-]
-
-[[package]]
-name = "itoa"
-version = "1.0.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "af150ab688ff2122fcef229be89cb50dd66af9e01a4ff320cc137eecc9bacc38"
-
-[[package]]
-name = "js-sys"
-version = "0.3.64"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c5f195fe497f702db0f318b07fdd68edb16955aed830df8363d837542f8f935a"
-dependencies = [
- "wasm-bindgen",
-]
-
-[[package]]
-name = "libc"
-version = "0.2.148"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9cdc71e17332e86d2e1d38c1f99edcb6288ee11b815fb1a4b049eaa2114d369b"
-
-[[package]]
-name = "linux-raw-sys"
-version = "0.4.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1a9bad9f94746442c783ca431b22403b519cd7fbeed0533fdd6328b2f2212128"
-
-[[package]]
-name = "log"
-version = "0.4.20"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f"
-
-[[package]]
-name = "mdbook"
-version = "0.4.34"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c55eb7c4dad20cc5bc15181c2aaf43d5689d5c3e0b80b50cc4cf0b7fe72a26d9"
-dependencies = [
- "anyhow",
- "chrono",
- "clap",
- "clap_complete",
- "env_logger",
- "handlebars",
- "log",
- "memchr",
- "once_cell",
- "opener",
- "pulldown-cmark",
- "regex",
- "serde",
- "serde_json",
- "shlex",
- "tempfile",
- "toml",
- "topological-sort",
-]
-
-[[package]]
-name = "mdbook-diff2html"
-version = "0.1.0"
-dependencies = [
- "anyhow",
- "clap",
- "mdbook",
- "pulldown-cmark",
- "semver",
- "serde_json",
-]
-
-[[package]]
-name = "memchr"
-version = "2.6.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8f232d6ef707e1956a43342693d2a31e72989554d58299d7a88738cc95b0d35c"
-
-[[package]]
-name = "normpath"
-version = "1.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ec60c60a693226186f5d6edf073232bfb6464ed97eb22cf3b01c1e8198fd97f5"
-dependencies = [
- "windows-sys",
-]
-
-[[package]]
-name = "num-traits"
-version = "0.2.16"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f30b0abd723be7e2ffca1272140fac1a2f084c77ec3e123c192b66af1ee9e6c2"
-dependencies = [
- "autocfg",
-]
-
-[[package]]
-name = "once_cell"
-version = "1.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d"
-
-[[package]]
-name = "opener"
-version = "0.6.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6c62dcb6174f9cb326eac248f07e955d5d559c272730b6c03e396b443b562788"
-dependencies = [
- "bstr",
- "normpath",
- "winapi",
-]
-
-[[package]]
-name = "pest"
-version = "2.7.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d7a4d085fd991ac8d5b05a147b437791b4260b76326baf0fc60cf7c9c27ecd33"
-dependencies = [
- "memchr",
- "thiserror",
- "ucd-trie",
-]
-
-[[package]]
-name = "pest_derive"
-version = "2.7.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a2bee7be22ce7918f641a33f08e3f43388c7656772244e2bbb2477f44cc9021a"
-dependencies = [
- "pest",
- "pest_generator",
-]
-
-[[package]]
-name = "pest_generator"
-version = "2.7.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d1511785c5e98d79a05e8a6bc34b4ac2168a0e3e92161862030ad84daa223141"
-dependencies = [
- "pest",
- "pest_meta",
- "proc-macro2",
- "quote",
- "syn",
-]
-
-[[package]]
-name = "pest_meta"
-version = "2.7.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b42f0394d3123e33353ca5e1e89092e533d2cc490389f2bd6131c43c634ebc5f"
-dependencies = [
- "once_cell",
- "pest",
- "sha2",
-]
-
-[[package]]
-name = "proc-macro2"
-version = "1.0.67"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3d433d9f1a3e8c1263d9456598b16fec66f4acc9a74dacffd35c7bb09b3a1328"
-dependencies = [
- "unicode-ident",
-]
-
-[[package]]
-name = "pulldown-cmark"
-version = "0.9.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "77a1a2f1f0a7ecff9c31abbe177637be0e97a0aef46cf8738ece09327985d998"
-dependencies = [
- "bitflags 1.3.2",
- "memchr",
- "unicase",
-]
-
-[[package]]
-name = "quote"
-version = "1.0.33"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae"
-dependencies = [
- "proc-macro2",
-]
-
-[[package]]
-name = "redox_syscall"
-version = "0.3.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "567664f262709473930a4bf9e51bf2ebf3348f2e748ccc50dea20646858f8f29"
-dependencies = [
- "bitflags 1.3.2",
-]
-
-[[package]]
-name = "regex"
-version = "1.9.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "697061221ea1b4a94a624f67d0ae2bfe4e22b8a17b6a192afb11046542cc8c47"
-dependencies = [
- "aho-corasick",
- "memchr",
- "regex-automata",
- "regex-syntax",
-]
-
-[[package]]
-name = "regex-automata"
-version = "0.3.8"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c2f401f4955220693b56f8ec66ee9c78abffd8d1c4f23dc41a23839eb88f0795"
-dependencies = [
- "aho-corasick",
- "memchr",
- "regex-syntax",
-]
-
-[[package]]
-name = "regex-syntax"
-version = "0.7.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dbb5fb1acd8a1a18b3dd5be62d25485eb770e05afb408a9627d14d451bae12da"
-
-[[package]]
-name = "rustix"
-version = "0.38.14"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "747c788e9ce8e92b12cd485c49ddf90723550b654b32508f979b71a7b1ecda4f"
-dependencies = [
- "bitflags 2.4.0",
- "errno",
- "libc",
- "linux-raw-sys",
- "windows-sys",
-]
-
-[[package]]
-name = "ryu"
-version = "1.0.15"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1ad4cc8da4ef723ed60bced201181d83791ad433213d8c24efffda1eec85d741"
-
-[[package]]
-name = "semver"
-version = "1.0.19"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ad977052201c6de01a8ef2aa3378c4bd23217a056337d1d6da40468d267a4fb0"
-
-[[package]]
-name = "serde"
-version = "1.0.188"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf9e0fcba69a370eed61bcf2b728575f726b50b55cba78064753d708ddc7549e"
-dependencies = [
- "serde_derive",
-]
-
-[[package]]
-name = "serde_derive"
-version = "1.0.188"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4eca7ac642d82aa35b60049a6eccb4be6be75e599bd2e9adb5f875a737654af2"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn",
-]
-
-[[package]]
-name = "serde_json"
-version = "1.0.107"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6b420ce6e3d8bd882e9b243c6eed35dbc9a6110c9769e74b584e0d68d1f20c65"
-dependencies = [
- "itoa",
- "ryu",
- "serde",
-]
-
-[[package]]
-name = "sha2"
-version = "0.10.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "479fb9d862239e610720565ca91403019f2f00410f1864c5aa7479b950a76ed8"
-dependencies = [
- "cfg-if",
- "cpufeatures",
- "digest",
-]
-
-[[package]]
-name = "shlex"
-version = "1.2.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a7cee0529a6d40f580e7a5e6c495c8fbfe21b7b52795ed4bb5e62cdf92bc6380"
-
-[[package]]
-name = "strsim"
-version = "0.10.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"
-
-[[package]]
-name = "syn"
-version = "2.0.37"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7303ef2c05cd654186cb250d29049a24840ca25d2747c25c0381c8d9e2f582e8"
-dependencies = [
- "proc-macro2",
- "quote",
- "unicode-ident",
-]
-
-[[package]]
-name = "tempfile"
-version = "3.8.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cb94d2f3cc536af71caac6b6fcebf65860b347e7ce0cc9ebe8f70d3e521054ef"
-dependencies = [
- "cfg-if",
- "fastrand",
- "redox_syscall",
- "rustix",
- "windows-sys",
-]
-
-[[package]]
-name = "termcolor"
-version = "1.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6093bad37da69aab9d123a8091e4be0aa4a03e4d601ec641c327398315f62b64"
-dependencies = [
- "winapi-util",
-]
-
-[[package]]
-name = "terminal_size"
-version = "0.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "21bebf2b7c9e0a515f6e0f8c51dc0f8e4696391e6f1ff30379559f8365fb0df7"
-dependencies = [
- "rustix",
- "windows-sys",
-]
-
-[[package]]
-name = "thiserror"
-version = "1.0.48"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9d6d7a740b8a666a7e828dd00da9c0dc290dff53154ea77ac109281de90589b7"
-dependencies = [
- "thiserror-impl",
-]
-
-[[package]]
-name = "thiserror-impl"
-version = "1.0.48"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "49922ecae66cc8a249b77e68d1d0623c1b2c514f0060c27cdc68bd62a1219d35"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn",
-]
-
-[[package]]
-name = "toml"
-version = "0.5.11"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f4f7f0dd8d50a853a531c426359045b1998f04219d88799810762cd4ad314234"
-dependencies = [
- "serde",
-]
-
-[[package]]
-name = "topological-sort"
-version = "0.2.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ea68304e134ecd095ac6c3574494fc62b909f416c4fca77e440530221e549d3d"
-
-[[package]]
-name = "typenum"
-version = "1.17.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
-
-[[package]]
-name = "ucd-trie"
-version = "0.1.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ed646292ffc8188ef8ea4d1e0e0150fb15a5c2e12ad9b8fc191ae7a8a7f3c4b9"
-
-[[package]]
-name = "unicase"
-version = "2.7.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f7d2d4dafb69621809a81864c9c1b864479e1235c0dd4e199924b9742439ed89"
-dependencies = [
- "version_check",
-]
-
-[[package]]
-name = "unicode-ident"
-version = "1.0.12"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
-
-[[package]]
-name = "utf8parse"
-version = "0.2.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a"
-
-[[package]]
-name = "version_check"
-version = "0.9.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
-
-[[package]]
-name = "wasm-bindgen"
-version = "0.2.87"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7706a72ab36d8cb1f80ffbf0e071533974a60d0a308d01a5d0375bf60499a342"
-dependencies = [
- "cfg-if",
- "wasm-bindgen-macro",
-]
-
-[[package]]
-name = "wasm-bindgen-backend"
-version = "0.2.87"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5ef2b6d3c510e9625e5fe6f509ab07d66a760f0885d858736483c32ed7809abd"
-dependencies = [
- "bumpalo",
- "log",
- "once_cell",
- "proc-macro2",
- "quote",
- "syn",
- "wasm-bindgen-shared",
-]
-
-[[package]]
-name = "wasm-bindgen-macro"
-version = "0.2.87"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dee495e55982a3bd48105a7b947fd2a9b4a8ae3010041b9e0faab3f9cd028f1d"
-dependencies = [
- "quote",
- "wasm-bindgen-macro-support",
-]
-
-[[package]]
-name = "wasm-bindgen-macro-support"
-version = "0.2.87"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "54681b18a46765f095758388f2d0cf16eb8d4169b639ab575a8f5693af210c7b"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn",
- "wasm-bindgen-backend",
- "wasm-bindgen-shared",
-]
-
-[[package]]
-name = "wasm-bindgen-shared"
-version = "0.2.87"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ca6ad05a4870b2bf5fe995117d3728437bd27d7cd5f06f13c17443ef369775a1"
-
-[[package]]
-name = "winapi"
-version = "0.3.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
-dependencies = [
- "winapi-i686-pc-windows-gnu",
- "winapi-x86_64-pc-windows-gnu",
-]
-
-[[package]]
-name = "winapi-i686-pc-windows-gnu"
-version = "0.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
-
-[[package]]
-name = "winapi-util"
-version = "0.1.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f29e6f9198ba0d26b4c9f07dbe6f9ed633e1f3d5b8b414090084349e46a52596"
-dependencies = [
- "winapi",
-]
-
-[[package]]
-name = "winapi-x86_64-pc-windows-gnu"
-version = "0.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
-
-[[package]]
-name = "windows"
-version = "0.48.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e686886bc078bc1b0b600cac0147aadb815089b6e4da64016cbd754b6342700f"
-dependencies = [
- "windows-targets",
-]
-
-[[package]]
-name = "windows-sys"
-version = "0.48.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
-dependencies = [
- "windows-targets",
-]
-
-[[package]]
-name = "windows-targets"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c"
-dependencies = [
- "windows_aarch64_gnullvm",
- "windows_aarch64_msvc",
- "windows_i686_gnu",
- "windows_i686_msvc",
- "windows_x86_64_gnu",
- "windows_x86_64_gnullvm",
- "windows_x86_64_msvc",
-]
-
-[[package]]
-name = "windows_aarch64_gnullvm"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8"
-
-[[package]]
-name = "windows_aarch64_msvc"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc"
-
-[[package]]
-name = "windows_i686_gnu"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e"
-
-[[package]]
-name = "windows_i686_msvc"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406"
-
-[[package]]
-name = "windows_x86_64_gnu"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e"
-
-[[package]]
-name = "windows_x86_64_gnullvm"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc"
-
-[[package]]
-name = "windows_x86_64_msvc"
-version = "0.48.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538"
diff --git a/tutorial/mdbook-diff2html/Cargo.toml b/tutorial/mdbook-diff2html/Cargo.toml
deleted file mode 100644
index 6717821..0000000
--- a/tutorial/mdbook-diff2html/Cargo.toml
+++ /dev/null
@@ -1,16 +0,0 @@
-[package]
-name = "mdbook-diff2html"
-version = "0.1.0"
-edition = "2021"
-publish = false
-
-[dependencies]
-mdbook = { version = "0.4", default-features = false }
-pulldown-cmark = { version = "0.9", default-features = false }
-clap = { version = "4", default-features = false }
-serde_json = "1"
-semver = "1"
-anyhow = "1"
-
-# Empty workspace to ensure this is not part of the workspace in the root, because this is a separate project.
-[workspace]
diff --git a/tutorial/mdbook-diff2html/src/main.rs b/tutorial/mdbook-diff2html/src/main.rs
deleted file mode 100644
index fbd788d..0000000
--- a/tutorial/mdbook-diff2html/src/main.rs
+++ /dev/null
@@ -1,61 +0,0 @@
-use std::io;
-use std::io::{BufReader, BufWriter};
-use std::process;
-
-use anyhow::Result;
-use clap::{Arg, ArgMatches, Command};
-use mdbook::preprocess::CmdPreprocessor;
-use semver::{Version, VersionReq};
-
-use preprocessor::Diff2Html;
-
-mod preprocessor;
-
-fn main() {
- let command = Command::new("mdbook-diff2html")
- .about("A mdbook preprocessor for showing highlighted diffs with diff2html")
- .subcommand(
- Command::new("supports")
- .arg(Arg::new("renderer").required(true))
- .about("Check whether a renderer is supported by this preprocessor"),
- );
- let matches = command.get_matches();
-
- let mut preprocessor = Diff2Html::default();
- if let Some(sub_args) = matches.subcommand_matches("supports") {
- handle_supports(sub_args);
- } else if let Err(e) = handle_preprocessing(&mut preprocessor) {
- eprintln!("{}", e);
- process::exit(1);
- }
-}
-
-fn handle_preprocessing(preprocessor: &mut Diff2Html) -> Result<()> {
- let (ctx, mut book) = CmdPreprocessor::parse_input(BufReader::new(io::stdin()))?;
-
- let book_version = Version::parse(&ctx.mdbook_version)?;
- let version_req = VersionReq::parse(mdbook::MDBOOK_VERSION)?;
- if !version_req.matches(&book_version) {
- eprintln!(
- "Warning: The mdbook-diff2html plugin was built against version {} of mdbook, but we're being called from version {}",
- mdbook::MDBOOK_VERSION,
- ctx.mdbook_version
- );
- }
-
- preprocessor.process_book(&ctx, &mut book)?;
- serde_json::to_writer(BufWriter::new(io::stdout()), &book)?;
-
- Ok(())
-}
-
-fn handle_supports(sub_args: &ArgMatches) -> ! {
- let renderer = sub_args
- .get_one::("renderer")
- .expect("Required argument");
- if renderer == "html" { // Signal whether the renderer is supported by exiting with 1 or 0.
- process::exit(0);
- } else {
- process::exit(1);
- }
-}
diff --git a/tutorial/mdbook-diff2html/src/preprocessor.rs b/tutorial/mdbook-diff2html/src/preprocessor.rs
deleted file mode 100644
index e5ccd14..0000000
--- a/tutorial/mdbook-diff2html/src/preprocessor.rs
+++ /dev/null
@@ -1,131 +0,0 @@
-use std::ops::Range;
-use std::path::{Path, PathBuf};
-
-use anyhow::{Context, Result};
-use mdbook::book::{Book, Chapter};
-use mdbook::BookItem;
-use mdbook::preprocess::PreprocessorContext;
-use pulldown_cmark::{CodeBlockKind, Event, Parser, Tag};
-
-#[derive(Default)]
-pub struct Diff2Html {
- text: String,
- replacements: Vec<(Range, String)>,
-}
-
-impl Diff2Html {
- pub fn process_book(&mut self, context: &PreprocessorContext, book: &mut Book) -> Result<()> {
- let root_directory = &context.root;
- let source_directory = root_directory.join(&context.config.book.src);
- for item in &mut book.sections {
- self.process_item(item, &source_directory)?;
- }
- Ok(())
- }
-
- fn process_item(&mut self, item: &mut BookItem, source_directory: &Path) -> Result<()> {
- match item {
- BookItem::Chapter(chapter) => {
- self.process_chapter(chapter, source_directory)?;
- for sub_item in &mut chapter.sub_items {
- self.process_item(sub_item, source_directory)?;
- }
- }
- _ => {}
- };
- Ok(())
- }
-
- fn process_chapter(&mut self, chapter: &mut Chapter, source_directory: &Path) -> Result<()> {
- self.text.clear();
- self.replacements.clear();
-
- let mut in_diff = false;
- let mut from_file = false;
- let mut div_id_counter = 0;
-
- let parser = Parser::new(&chapter.content);
- for (event, range) in parser.into_offset_iter() {
- match event {
- Event::Start(Tag::CodeBlock(CodeBlockKind::Fenced(s))) if s.contains("diff2html") => {
- in_diff = true;
- if s.contains("fromfile") {
- from_file = true;
- }
- self.text.clear();
- }
- Event::Text(t) if in_diff => {
- self.text.extend(t.chars());
- }
- Event::End(Tag::CodeBlock(CodeBlockKind::Fenced(s))) if in_diff => {
- let text = if from_file {
- let file_path = Path::new(self.text.trim());
- let file_path = if file_path.is_relative() {
- to_absolute_path(source_directory, chapter.source_path.as_deref(), file_path)
- .with_context(|| format!("failed to create absolute path to diff file: {}", file_path.display()))?
- } else {
- file_path.to_path_buf()
- };
- std::fs::read_to_string(&file_path)
- .with_context(|| format!("failed to read diff from: {}", file_path.display()))?
- } else {
- self.text.clone()
- };
- let line_by_line = s.contains("linebyline");
- let html = diff_to_html(text, div_id_counter, line_by_line);
- self.replacements.push((range, html));
- div_id_counter += 1;
- from_file = false;
- in_diff = false;
- }
- _ => {}
- }
- }
-
- // Note: applying replacements in reverse so that ranges are not invalidated.
- for (range, html) in self.replacements.drain(..).rev() {
- chapter.content.replace_range(range, &html)
- }
-
- Ok(())
- }
-}
-
-fn to_absolute_path(source_directory: &Path, source_file_path: Option<&Path>, relative_file_path: &Path) -> Result {
- let source_file_path = source_file_path
- .context("no source file path available")?;
- let source_directory_path = source_file_path.parent()
- .with_context(|| format!("source file path '{}' has no parent", source_file_path.display()))?;
- Ok(source_directory.join(source_directory_path).join(relative_file_path))
-}
-
-fn diff_to_html(diff: String, div_id_counter: usize, line_by_line: bool) -> String {
- // Escape $ and ` from the diff text, as these are special characters in JS template strings.
- let diff = diff.replace('$', r#"${"$"}"#);
- let diff = diff.replace('`', r#"${"`"}"#);
-
- let output_format = match line_by_line {
- true => "line-by-line",
- false => "side-by-side"
- };
-
- format!(r#"
-
-
-"#)
-}
diff --git a/tutorial/src/0_intro/1_setup/Cargo.toml b/tutorial/src/0_intro/1_setup/Cargo.toml
deleted file mode 100644
index 1e17190..0000000
--- a/tutorial/src/0_intro/1_setup/Cargo.toml
+++ /dev/null
@@ -1,4 +0,0 @@
-[package]
-name = "pie"
-version = "0.1.0"
-edition = "2021"
diff --git a/tutorial/src/0_intro/1_setup/index.md b/tutorial/src/0_intro/1_setup/index.md
deleted file mode 100644
index e9a87ef..0000000
--- a/tutorial/src/0_intro/1_setup/index.md
+++ /dev/null
@@ -1,94 +0,0 @@
-# Setup
-
-## Rust
-
-We will be using [Rust](https://www.rust-lang.org/) to implement a programmatic incremental build system.
-Therefore, first make sure [Rust is installed](https://www.rust-lang.org/tools/install).
-
-If you already have Rust installed, make sure to update to at least Rust 1.65.0 (Nov 2022), as we're using features only available from that release.
-
-Once Rust is installed, you should have access to [cargo](https://doc.rust-lang.org/cargo/).
-Cargo is Rust's package manager but also the command-line tool that ties everything together.
-Verify your Rust installation by running `cargo` from the command-line, which will show the help page for the cargo command.
-
-## Rust Editor / IDE
-
-This tutorial does not require a specific Rust editor or IDE.
-All you need is some way to edit files, and some way to run `cargo`.
-
-If you like to work in a terminal, [rust-analyzer](https://rust-analyzer.github.io/), the primary Language Server Protocol (LSP) implementation of Rust, can be used in [Emacs](https://rust-analyzer.github.io/manual.html#emacs) and [Vim/Neovim](https://rust-analyzer.github.io/manual.html#vimneovim).
-
-If you prefer a graphical editor, a popular choice is [Visual Studio Code](https://code.visualstudio.com/) with the [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) plugin.
-
-Personally, I am using the [RustRover](https://www.jetbrains.com/rust/) IDE, as it provides (in my opinion) the most polished and feature-full Rust editor/IDE.
-At the time of writing, RustRover is still in early access preview, meaning that it is free to use, but is still technically beta software.
-However, it is very stable despite being in preview.
-Once RustRover comes out of preview, you will need to pay for it though (or apply for a [free educational](https://www.jetbrains.com/community/education/#students/) or [open source](https://www.jetbrains.com/community/opensource/#support) license).
-
-## Creating a new Rust project
-
-In this tutorial, we will create a subset of the [PIE in Rust](https://github.com/Gohla/pie) library, so we want to create a Rust library called `pie`.
-However, later on in the tutorial we will also create an additional library for unit testing utilities, so we need to set up a Rust project that supports multiple libraries.
-
-Therefore, first create a `programmatic-builds` directory, which will serve as the root directory of the project.
-This does not have to be called `programmatic-builds`, you can use a different name.
-
-```admonish warning title="Important"
-In the rest of the tutorial, we assume that you are in your `programmatic-builds` root directory.
-So if you are instructed to create files or directories, they are always relative to your `programmatic-builds` root directory!
-```
-
-Now let's set up the `pie` library.
-Create the `pie` directory, and then create the `pie/Cargo.toml` file with the following contents:
-
-```toml,
-{{#include Cargo.toml}}
-```
-
-Then create the `pie/src` directory and create the `pie/src/lib.rs` file, which will be left empty for now.
-
-This marks `pie` as a Rust library, with version "0.1.0" and using Rust edition 2021.
-The directory structure should look as follows (inside your `programmatic-builds` root directory):
-
-```
-{{#include ../../gen/0_intro/1_setup/dir.txt}}
-```
-
-Now we can build the project to see if it was set up correctly.
-Open up a terminal, go into the `pie` directory, and run `cargo build`.
-If all is well, the output should look something like:
-
-```shell,
-{{#include ../../gen/0_intro/1_setup/cargo.txt}}
-```
-
-```admonish warning title="Important"
-In the rest of the tutorial, if you are instructed to run `cargo` commands, always run them inside the `pie` directory!
-```
-
-If you're using a Rust editor or IDE, it probably also has a mechanism for running cargo on your project.
-You can of course use that in place of running cargo from a terminal.
-
-```admonish tip title="Rust Editions" collapsible=true
-[Rust editions](https://doc.rust-lang.org/edition-guide/introduction.html) enable new features as an opt-in, without breaking existing code.
-We use [Rust edition 2021](https://doc.rust-lang.org/edition-guide/rust-2021/index.html), which is the latest edition at the time of writing.
-```
-
-## Source control (optional)
-
-I recommend storing your code in a source control system such as [Git](https://git-scm.com/), and uploading it to a source code hub such as [GitHub](https://github.com/).
-A source control system allows you to look at changes and to go back to older versions, and uploading to a source code hub then provides a convenient backup.
-
-If you use Git, create the `pie/.gitignore` file with:
-
-```.gitignore
-/target
-```
-
-This ignores the `target` directory that Rust/Cargo uses to store intermediate and binary files.
-
-Continue to the next chapter where we will start implementing the "programmatic" part of programmatic incremental build systems.
-
-```admonish example title="Download source code" collapsible=true
-You can [download the source files up to this point](../../gen/0_intro/1_setup/source.zip).
-```
diff --git a/tutorial/src/0_intro/index.md b/tutorial/src/0_intro/index.md
deleted file mode 100644
index 285e040..0000000
--- a/tutorial/src/0_intro/index.md
+++ /dev/null
@@ -1,129 +0,0 @@
-# Build your own Programmatic Incremental Build System
-
-This is a programming tutorial where you will build your own _programmatic incremental build system_ in [Rust](https://www.rust-lang.org/).
-
-The primary goal of this tutorial is to provide understanding of programmatic incremental build systems through implementation and experimentation.
-
-Although the tutorial uses Rust, you _don't_ need to be a Rust expert to follow it.
-A secondary goal of this tutorial is to teach more about Rust through implementation and experimentation, given that you already have programming experience (in another language) and are willing to learn.
-Therefore, all Rust code is available, and I try to explain and link to the relevant Rust book chapters as much as possible.
-
-This is of course not a full tutorial or book on Rust.
-For that, I can recommend the excellent [The Rust Programming Language](https://doc.rust-lang.org/book/) book.
-However, if you like to learn through examples and experimentation, or already know Rust basics and want to practice, this might be a fun programming tutorial for you!
-
-[//]: # ()
-[//]: # (Another secondary goal is to show what I think are several good software writing practices, such as dividing code into modules, thinking about what to expose as API, writing unit and integration tests, etc.)
-
-[//]: # (Where possible I will try to explain design decisions, discuss tradeoffs, or provide more info about optimizations.)
-
-We will first motivate programmatic incremental build systems.
-
-## Motivation
-
-A programmatic incremental build system is a mix between an incremental build system and an incremental computation system, with the following key properties:
-
-- _Programmatic_: Build scripts are regular programs written in a programming language, where parts of the build script implement an API from the build system. This enables build authors to write incremental builds with the full expressiveness of the programming language.
-- _Incremental_: Builds are truly incremental -- only the parts of a build that are affected by changes are executed.
-- _Correct_: Builds are fully correct -- all parts of the build that are affected by changes are executed. Builds are free of glitches: only up-to-date (consistent) data is observed.
-- _Automatic_: The build system takes care of incrementality and correctness. Build authors _do not_ have to manually implement incrementality. Instead, they only have to explicitly _declare dependencies_.
-- _Multipurpose_: The same build script can be used for incremental batch builds in a terminal, but also for live feedback in an interactive environment such as an IDE. For example, a compiler implemented in this build system can provide incremental batch compilation but also incremental editor services such as syntax highlighting or code completion.
-
-#### Teaser Toy Example
-
-As a small teaser, here is a simplified version of a programmatic incremental toy build script that copies a text file by reading and writing:
-
-```rust
-struct ReadFile { file: PathBuf }
-impl Task for ReadFile {
- fn execute(&self, context: &mut C) -> Result {
- context.require_file(&self.file)?;
- fs::read_to_string(&self.file)
- }
-}
-
-struct WriteFile { task: T, file: PathBuf }
-impl Task for WriteFile {
- fn execute(&self, context: &mut C) -> Result<(), io::Error> {
- let string: String = context.require_task(&self.task)?;
- fs::write(&self.file, string.as_bytes())?;
- context.provide_file(&self.file)
- }
-}
-
-fn main() {
- let read_task = ReadFile { file: PathBuf::from("in.txt") };
- let write_task = WriteFile { task: read_task, file: PathBuf::from("out.txt") };
- Pie::default().new_session().require(&write_task);
-}
-```
-
-The unit of computation in a programmatic incremental build system is a _task_.
-A task is kind of like a closure, a function along with its inputs that can be executed, but incremental.
-For example, the `ReadFile` task carries the file path it reads from.
-When we `execute` the task, it reads from the file and returns its text as a string.
-However, due to incrementality, we mark the file as a `require_file` dependency through `context`, such that this task is only re-executed when the file changes!
-
-Note that this file read dependency is created _while the task is executing_.
-We call these _dynamic dependencies_.
-This is one of the main benefits of programmatic incremental build systems: you create dependencies _while the build is executing_, instead of having to declare them upfront!
-
-Dynamic dependencies are also created between tasks.
-For example, `WriteFile` carries a task as input, which it requires with `context.require_task` to retrieve the text for writing to a file.
-We'll cover how this works later on in the tutorial.
-For now, let's zoom back out to the motivation of programmatic incremental build systems.
-
-#### Back to Motivation
-
-I prefer writing builds in a programming language like this, over having to _encode_ a build into a YAML file with underspecified semantics, and over having to learn and use a new build scripting language with limited tooling.
-By _programming builds_, I can reuse my knowledge of the programming language, I get help from the compiler and IDE that I'd normally get while programming, I can modularize and reuse parts of my build as a library, and can use other programming language features such as unit testing, integration testing, benchmarking, etc.
-
-Programmatic builds _do not exclude declarativity_, however.
-You can layer declarative features on top of programmatic builds, such as declarative configuration files that determine _what_ should be built without having to specify _how_ things are built.
-For example, you could write a task like the one from the example, which reads and parses a config file, and then dispatch tasks that build required things.
-Therefore, programmatic builds are useful for both small one-off builds, and for creating larger incremental build systems that work with a lot of user inputs.
-
-Dynamic dependencies enable creating precise dependencies, _without requiring staging_, as is often found in build systems with static dependencies.
-For example, dynamic dependencies in [Make](https://www.gnu.org/software/make/) requires staging: generate new makefiles and recursively execute them, which is tedious and error-prone.
-[Gradle](https://gradle.org/) has a two-staged build process: first configure the task graph, then incrementally execute it.
-In the execution stage, you cannot modify dependencies or create new tasks.
-Therefore, more work needs to be done in the configuration stage, which is not (fully) incrementalized.
-Dynamic dependencies solve these problems by doing away with staging!
-
-Finally, precise dynamic dependencies enable incrementality but also correctness.
-A task is re-executed when one or more of its dependencies become inconsistent.
-For example, the `WriteFile` task from the example is re-executed when the task dependency returns different text, or when the file it writes to is modified or deleted.
-This is both incremental and correct.
-
-#### Disadvantages
-
-Of course, programmatic incremental build systems also have some disadvantages.
-These disadvantages become more clear during the tutorial, but I want to list them here to be up-front about it:
-
-- The build system is more complicated, but hopefully this tutorial can help mitigate some of that by understanding the key ideas through implementation and experimentation.
-- Some correctness properties are checked while building. Therefore, you need to test your builds to try to catch these issues before they reach users. However, I think that testing builds is something you should do regardless of the build system, to be more confident about the correctness of your build.
-- More tracking is required at runtime compared to non-programmatic build systems. However, in our experience, the overhead is not excessive unless you try to do very fine-grained incrementalization. For fine-grained incrementalization, [incremental computing](https://en.wikipedia.org/wiki/Incremental_computing) approaches are more well suited.
-
-## PIE: a Programmatic Incremental Build System in Rust
-
-We have developed [PIE, a Rust library](https://github.com/Gohla/pie) implementing a programmatic incremental build system adhering to the key properties listed above.
-It is still under development, and has not been published to crates.io yet, but it is already usable
-If you are interested in experimenting with a programmatic incremental build system, do check it out!
-
-In this tutorial we will implement a subset of [PIE, the Rust library](https://github.com/Gohla/pie).
-We simplify the internals in order to minimize distractions as much as possible, but still go over all the key ideas and concepts that make programmatic incremental build systems tick.
-
-However, the _idea_ of programmatic incremental build systems is not limited to PIE or the Rust language.
-You can implement a programmatic incremental build systems in any general-purpose programming language, or adapt the idea to better fit your preferences and/or requirements.
-In fact, we first implemented [PIE in Java](https://github.com/metaborg/pie), with [PIE in Rust](https://github.com/Gohla/pie) being the second iteration, mostly simplifying internals to make it easier to explain.
-
-For a more thorough discussion of future, existing, and related work, see [the last chapter of this book](../4_next/index.md).
-
-## Feedback & Contributing
-
-This tutorial is open source, hosted at .
-If you find an error in the code or text of this tutorial, or want to report other kinds of problems, you can report it on the [issue tracker](https://github.com/Gohla/pie/issues).
-Small fixes can be sent as a pull request by pressing the edit button in the top-right corner.
-
-Let's continue with the tutorial.
-The next section covers installing Rust and setting up a fresh Rust project.
diff --git a/tutorial/src/1_programmability/1_api/a_api.rs b/tutorial/src/1_programmability/1_api/a_api.rs
deleted file mode 100644
index 4a0995b..0000000
--- a/tutorial/src/1_programmability/1_api/a_api.rs
+++ /dev/null
@@ -1,17 +0,0 @@
-use std::fmt::Debug;
-use std::hash::Hash;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires given `task`, recording a dependency and selectively executing it. Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output;
-}
diff --git a/tutorial/src/1_programmability/1_api/index.md b/tutorial/src/1_programmability/1_api/index.md
deleted file mode 100644
index 9e153f3..0000000
--- a/tutorial/src/1_programmability/1_api/index.md
+++ /dev/null
@@ -1,106 +0,0 @@
-# Programmable Build System API
-
-In this section, we will program the core API of the programmatic incremental build system.
-Although we are primarily concerned with programmability in this chapter, we must design the API to support incrementality!
-
-The unit of computation in a programmatic build system is a _task_.
-A task is kind of like a closure: a value that can be executed to produce their output, but _incremental_.
-To provide incrementality, we also need to keep track of the _dynamic dependencies_ that tasks make while they are executing.
-Therefore, tasks are executed under an _incremental build context_, enabling them to create these dynamic dependencies.
-
-Tasks _require_ files through the build context, creating a dynamic file dependency, ensuring the task gets re-executed when that file changes.
-Tasks also _require other tasks_ through the build context, asking the build context to provide the consistent (most up-to-date) output of that task, and creating a dynamic task dependency to it.
-
-It is then up to the build context to _check_ if it actually needs to execute that required task.
-If the required task is already consistent, the build context can just return the cached output of that task.
-Otherwise, the build context _executes_ the required task, caches its output, and returns the output to the requiring task.
-A non-incremental context can naively execute tasks without checking.
-
-Because tasks require other tasks through the context, and the context selectively executes tasks, the definition of task and context is mutually recursive.
-
-```admonish abstract title="Context"
-In this tutorial, we will be using the words *context*, *build context*, and *build system* interchangeably, typically using just *context* as it is concise.
-```
-
-Let's make tasks and contexts more concrete by defining them in code.
-
-## API Implementation
-
-Since we want users of the build system to implement their own tasks, we will define `Task` as a trait.
-Likewise, we will also be implementing multiple contexts in this tutorial, so we will also define `Context` as a trait.
-Add the following code to your `pie/src/lib.rs` file:
-
-```rust,
-{{#include a_api.rs}}
-```
-
-```admonish tip
-If this seems overwhelming to you, don't worry. We will go through the API and explain things. But more importantly, the API should become more clear once we implement it in the next section and subsequent chapters.
-Furthermore, if you're new to Rust and/or need help understanding certain concepts, I will try to explain them in Rust Help blocks. They are collapsed by default to reduce distraction, clicking the header opens them. See the first Rust Help block at the end of this section.
-```
-
-The `Task` trait has several supertraits that we will need later in the tutorial to implement incrementality:
-
-* `Eq` and `Hash`: to check whether a task is equal to another one, and to create a hash of it, so we can use
- a `HashMap` to get the output of a task if it is up-to-date.
-* `Clone`: to create a clone of the task so that we can store it in the `HashMap` without having ownership of it.
-* `Debug`: to format the task for debugging purposes.
-
-A `Task` has a single method `execute`, which takes a reference to itself (`&self`), and a mutable reference to a context (`context: &mut C`), and produces a value of type `Self::Output`.
-Because `Context` is a trait, we use generics (`>`) to have `execute` work for any `Context` implementation (ignoring the `Self` part for now).
-The `execute` method takes self by reference such that a task can access its data, but not mutate it, as that could throw off incrementality by changing the hash/equality of the task.
-Finally, the type of output of a task is defined by the `Output` associated type, and this type must implement `Clone`, `Eq`, and `Debug` for the same reason as `Task`.
-
-The `Context` trait is generic over `Task`, allowing it to work with any task implementation.
-It has a single method `require_task` for creating a dependency to a task and returning its consistent (up-to-date) result.
-It takes a mutable reference to itself, enabling dynamic dependency tracking and caching, which require mutation.
-Because of this, the context reference passed to `Task::execute` is also mutable.
-
-This `Task` and `Context` API mirrors the mutually recursive definition of task and context we discussed earlier, and forms the basis for the entire build system.
-
-```admonish note
-We will implement file dependencies in the next chapter, as file dependencies only become important with incrementality.
-```
-
-Build the project by running `cargo build`.
-The output should look something like:
-
-```shell,
-{{#include ../../gen/1_programmability/1_api/a_cargo.txt}}
-```
-
-In the next section, we will implement a non-incremental `Context` and test it against `Task` implementations.
-
-```admonish tip title="Rust Help: Modules, Imports, Ownership, Traits, Methods, Supertraits, Associated Types, Visibility" collapsible=true
-[The Rust Programming Language](https://doc.rust-lang.org/book/ch00-00-introduction.html) is an introductory book about Rust. I will try to provide links to the book where possible.
-
-Rust has a [module system](https://doc.rust-lang.org/book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html) for project organization. The `lib.rs` file is the "main file" of a library. Later on, we will be creating more modules in different files.
-
-Things are imported into the current scope with [`use`](https://doc.rust-lang.org/book/ch07-04-bringing-paths-into-scope-with-the-use-keyword.html) statements. We import the `Debug` and `Hash` traits from the standard library with two `use` statements. Use statements use [paths](https://doc.rust-lang.org/book/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html) to refer to nested things. We use `::` for nesting, similar to namespaces in C++.
-
-Rust models the concept of [ownership](https://doc.rust-lang.org/book/ch04-00-understanding-ownership.html) to enable memory safety without a garbage collector.
-The `execute` method accepts a *reference* to the current type, indicated with `&`: `&self`. This reference is *immutable*, meaning that we can read data from it, but not mutate it. In Rust, things are immutable by default.
-On the other hand, `execute` accepts a *mutable reference* to the context, indicated with `&mut`: `context: &mut C`, which does allow mutation.
-
-[Traits](https://doc.rust-lang.org/book/ch10-02-traits.html) are the main mechanism for open extensibility in Rust. They are comparable to interfaces in class-oriented languages. We will implement a context and tasks in the next section.
-
-[Supertraits](https://doc.rust-lang.org/book/ch19-03-advanced-traits.html#using-supertraits-to-require-one-traits-functionality-within-another-trait) are a kind of inheritance. The `: Clone + Eq + Hash + Debug` part of the `Task` trait means that every `Task` implementation must also implement the `Clone`, `Eq`, `Hash`, and `Debug` traits. These traits are part of the standard library:
-* [Clone](https://doc.rust-lang.org/std/clone/trait.Clone.html) for duplicating values.
-* [Eq](https://doc.rust-lang.org/std/cmp/trait.Eq.html) for equality comparisons, along with [PartialEq](https://doc.rust-lang.org/std/cmp/trait.PartialEq.html).
-* [Hash](https://doc.rust-lang.org/std/hash/trait.Hash.html) for turning a value into a hash.
-* [Debug](https://doc.rust-lang.org/std/fmt/trait.Debug.html) for formatting values in a programmer-facing debugging context.
-
-`Clone` and `Eq` are so common that they are part of the [Rust Prelude](https://doc.rust-lang.org/std/prelude/index.html), so we don't have to import those with `use` statements.
-
-[Methods](https://doc.rust-lang.org/book/ch05-03-method-syntax.html) are functions that take a form of `self` as the first argument. This enables convenient object-like calling syntax: `context.require_task(&task);`.
-
-[Associated types](https://doc.rust-lang.org/book/ch19-03-advanced-traits.html#specifying-placeholder-types-in-trait-definitions-with-associated-types) are a kind of placeholder type in a trait such that methods of traits can use that type. In `Task` this allows us to talk about the `Output` type of a task. In `Context` this allows us to refer to both the `Task` type `T` and its output type `T::Output`. The `::` syntax here is used to access associated types of traits.
-
-The `Self` type in a trait is a built-in associated type that is a placeholder for the type that is implementing the trait.
-
-The `Task` trait is defined with `pub` (public) [visibility](https://doc.rust-lang.org/reference/visibility-and-privacy.html), such that users of the library can implement it. Because `Task` uses `Context` in its public API, `Context` must also be public, even though we don't intend for users to implement their own `Context`.
-```
-
-```admonish example title="Download source code" collapsible=true
-You can [download the source files up to this point](../../gen/1_programmability/1_api/source.zip).
-```
diff --git a/tutorial/src/1_programmability/2_non_incremental/a_context_module.rs b/tutorial/src/1_programmability/2_non_incremental/a_context_module.rs
deleted file mode 100644
index 248946f..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/a_context_module.rs
+++ /dev/null
@@ -1,19 +0,0 @@
-use std::fmt::Debug;
-use std::hash::Hash;
-
-pub mod context;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires given `task`, recording a dependency and selectively executing it. Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output;
-}
diff --git a/tutorial/src/1_programmability/2_non_incremental/b_non_incremental_module.rs b/tutorial/src/1_programmability/2_non_incremental/b_non_incremental_module.rs
deleted file mode 100644
index bd9ab62..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/b_non_incremental_module.rs
+++ /dev/null
@@ -1 +0,0 @@
-pub mod non_incremental;
diff --git a/tutorial/src/1_programmability/2_non_incremental/c_non_incremental_context.rs b/tutorial/src/1_programmability/2_non_incremental/c_non_incremental_context.rs
deleted file mode 100644
index bb39334..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/c_non_incremental_context.rs
+++ /dev/null
@@ -1,10 +0,0 @@
-use crate::{Context, Task};
-
-pub struct NonIncrementalContext;
-
-impl Context for NonIncrementalContext {
- fn require_task(&mut self, task: &T) -> T::Output {
- task.execute(self)
- }
-}
-
diff --git a/tutorial/src/1_programmability/2_non_incremental/d_test.rs b/tutorial/src/1_programmability/2_non_incremental/d_test.rs
deleted file mode 100644
index 2ad2e29..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/d_test.rs
+++ /dev/null
@@ -1,20 +0,0 @@
-#[cfg(test)]
-mod test {
- use super::*;
-
- #[test]
- fn test_require_task_direct() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReturnHelloWorld;
-
- impl Task for ReturnHelloWorld {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- "Hello World!".to_string()
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("Hello World!", context.require_task(&ReturnHelloWorld));
- }
-}
diff --git a/tutorial/src/1_programmability/2_non_incremental/e_test_problematic.rs b/tutorial/src/1_programmability/2_non_incremental/e_test_problematic.rs
deleted file mode 100644
index 1baef0a..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/e_test_problematic.rs
+++ /dev/null
@@ -1,44 +0,0 @@
-#[cfg(test)]
-mod test {
- use super::*;
-
- #[test]
- fn test_require_task_direct() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReturnHelloWorld;
-
- impl Task for ReturnHelloWorld {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- "Hello World!".to_string()
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("Hello World!", context.require_task(&ReturnHelloWorld));
- }
-
- #[test]
- fn test_require_task_problematic() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReturnHelloWorld;
- impl Task for ReturnHelloWorld {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- "Hello World!".to_string()
- }
- }
-
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ToLowerCase;
- impl Task for ToLowerCase {
- type Output = String;
- fn execute>(&self, context: &mut C) -> Self::Output {
- context.require_task(&ReturnHelloWorld).to_lowercase()
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("hello world!", context.require_task(&ToLowerCase));
- }
-}
diff --git a/tutorial/src/1_programmability/2_non_incremental/f_test_incompatible.rs b/tutorial/src/1_programmability/2_non_incremental/f_test_incompatible.rs
deleted file mode 100644
index 9758184..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/f_test_incompatible.rs
+++ /dev/null
@@ -1,44 +0,0 @@
-#[cfg(test)]
-mod test {
- use super::*;
-
- #[test]
- fn test_require_task_direct() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReturnHelloWorld;
-
- impl Task for ReturnHelloWorld {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- "Hello World!".to_string()
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("Hello World!", context.require_task(&ReturnHelloWorld));
- }
-
- #[test]
- fn test_require_task_problematic() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReturnHelloWorld;
- impl Task for ReturnHelloWorld {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- "Hello World!".to_string()
- }
- }
-
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ToLowerCase;
- impl Task for ToLowerCase {
- type Output = String;
- fn execute>(&self, context: &mut C) -> Self::Output {
- context.require_task(&ReturnHelloWorld).to_lowercase()
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("hello world!", context.require_task(&ToLowerCase));
- }
-}
diff --git a/tutorial/src/1_programmability/2_non_incremental/g_remove_test.rs b/tutorial/src/1_programmability/2_non_incremental/g_remove_test.rs
deleted file mode 100644
index 2ad2e29..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/g_remove_test.rs
+++ /dev/null
@@ -1,20 +0,0 @@
-#[cfg(test)]
-mod test {
- use super::*;
-
- #[test]
- fn test_require_task_direct() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReturnHelloWorld;
-
- impl Task for ReturnHelloWorld {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- "Hello World!".to_string()
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("Hello World!", context.require_task(&ReturnHelloWorld));
- }
-}
diff --git a/tutorial/src/1_programmability/2_non_incremental/h_test_correct.rs b/tutorial/src/1_programmability/2_non_incremental/h_test_correct.rs
deleted file mode 100644
index fba3449..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/h_test_correct.rs
+++ /dev/null
@@ -1,43 +0,0 @@
-#[cfg(test)]
-mod test {
- use super::*;
-
- #[test]
- fn test_require_task_direct() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReturnHelloWorld;
-
- impl Task for ReturnHelloWorld {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- "Hello World!".to_string()
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("Hello World!", context.require_task(&ReturnHelloWorld));
- }
-
- #[test]
- fn test_require_task() {
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- enum Test {
- ReturnHelloWorld,
- ToLowerCase,
- }
-
- impl Task for Test {
- type Output = String;
- fn execute>(&self, context: &mut C) -> Self::Output {
- match self {
- Self::ReturnHelloWorld => "Hello World!".to_string(),
- Self::ToLowerCase => context.require_task(&Self::ReturnHelloWorld).to_lowercase(),
- }
- }
- }
-
- let mut context = NonIncrementalContext;
- assert_eq!("Hello World!", context.require_task(&Test::ReturnHelloWorld));
- assert_eq!("hello world!", context.require_task(&Test::ToLowerCase));
- }
-}
diff --git a/tutorial/src/1_programmability/2_non_incremental/index.md b/tutorial/src/1_programmability/2_non_incremental/index.md
deleted file mode 100644
index f140b1b..0000000
--- a/tutorial/src/1_programmability/2_non_incremental/index.md
+++ /dev/null
@@ -1,208 +0,0 @@
-# Non-Incremental Context
-
-We set up the `Task` and `Context` API in such a way that we can implement incrementality.
-However, incrementality is *hard*, so let's start with an extremely simple non-incremental `Context` implementation to get a feeling for the API.
-
-## Context module
-
-Since we will be implementing three different contexts in this tutorial, we will separate them in different modules.
-Create the `context` module by adding a module to `pie/src/lib.rs`:
-
-```diff2html fromfile linebyline
-../../gen/1_programmability/2_non_incremental/a_context_module.rs.diff
-```
-
-This is a diff over `pie/src/lib.rs` where lines with a green background are additions, lines with a red background are removals, lines without a special background are context on where to add/remove lines, and lines starting with `@@` denote changed lines (in unified diff style). This is similar to diffs on source code hubs like GitHub.
-
-Create the `pie/src/context` directory, and in it, create the `pie/src/context/mod.rs` file with the following contents:
-
-```rust,
-{{#include b_non_incremental_module.rs}}
-```
-
-Both modules are public so that users of our library can access context implementations.
-
-Create the `pie/src/context/non_incremental.rs` file, it will be empty for now.
-Your project structure should now look like:
-
-```
-{{#include ../../gen/1_programmability/2_non_incremental/b_dir.txt}}
-```
-
-Confirm your module structure is correct by building with `cargo build`.
-
-```admonish tip title="Rust Help: Modules, Visibility" collapsible=true
-Modules are typically [separated into different files](https://doc.rust-lang.org/book/ch07-05-separating-modules-into-different-files.html).
-Modules are declared with `mod context`.
-Then, the contents of a module are defined either by creating a sibling file with the same name: `context.rs`, or by creating a sibling directory with the same name, with a `mod.rs` file in it: `context/mod.rs`.
-Use the latter if you intend to nest modules, otherwise use the former.
-
-Like traits, modules also have [visibility](https://doc.rust-lang.org/reference/visibility-and-privacy.html).
-```
-
-## Implementation
-
-Implement the non-incremental context in `pie/src/context/non_incremental.rs` by adding:
-
-```rust,
-{{#include c_non_incremental_context.rs}}
-```
-
-This `NonIncrementalContext` is extremely simple: in `require_task` we unconditionally execute the task, and pass `self` along so the task we're calling can require additional tasks.
-Let's write some tests to see if this does what we expect.
-
-```admonish tip title="Rust Help: Crates (Libraries), Structs, Trait Implementations, Last Expression" collapsible=true
-In Rust, libraries are called [crates](https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html).
-We import the `Context` and `Task` traits from the root of your crate (i.e., the `src/lib.rs` file) using `crate::` as a prefix.
-
-[Structs](https://doc.rust-lang.org/book/ch05-01-defining-structs.html) are concrete types that can contain data through fields and implement traits, similar to classes in class-oriented languages.
-Since we don't need any data in `NonIncrementalContext`, we define it as a [unit-like struct](https://doc.rust-lang.org/book/ch05-01-defining-structs.html#unit-like-structs-without-any-fields).
-
-[Traits are implemented for a type](https://doc.rust-lang.org/book/ch10-02-traits.html#implementing-a-trait-on-a-type) with `impl Context for NonIncrementalContext { ... }`, where we then have to implement all methods and associated types of the trait.
-
-The `Context` trait is generic over `Task`, so in the `impl` block we introduce a type parameter `T` with `impl`, and use [trait bounds](https://doc.rust-lang.org/book/ch10-02-traits.html#using-trait-bounds-to-conditionally-implement-methods) as `impl` to declare that `T` must implement `Task`.
-
-The last expression of a function – in this case `task.execute(self)` in `require_task` which is an expression because it does not end with `;` – is used as the return value.
-We could also write that as `return task.execute(self);`, but that is more verbose.
-```
-
-## Simple Test
-
-Add the following test to `pie/src/context/non_incremental.rs`:
-
-```rust,
-{{#include d_test.rs}}
-```
-
-In this test, we create a struct `ReturnHelloWorld` which is the "hello world" of the build system.
-We implement `Task` for it, set its `Output` associated type to be `String`, and implement the `execute` method to just return `"Hello World!"`.
-We derive the `Clone`, `Eq`, `Hash`, and `Debug` traits for `ReturnHelloWorld` as they are required for all `Task`
-implementations.
-
-We require the task with our context by creating a `NonIncrementalContext`, calling its `require_task` method, passing
-in a reference to the task.
-It returns the output of the task, which we test with `assert_eq!`.
-
-Run the test by running `cargo test`.
-The output should look something like:
-
-```shell,
-{{#include ../../gen/1_programmability/2_non_incremental/d_cargo.txt}}
-```
-
-Which indicates that the test indeed succeeds!
-You can experiment by returning a different string from `ReturnHelloWorld::execute` to see what a failed test looks like.
-
-```admonish tip title="Rust Help: Unit Testing, Nested Items, Unused Parameters, Assertion Macros" collapsible=true
-[Unit tests](https://doc.rust-lang.org/book/ch11-03-test-organization.html#the-tests-module-and-cfgtest) for a module
-are typically defined by creating a nested module named `test` with the `#[cfg(test)]` attribute applied to it. In that
-`test` module, you apply `#[test]` to testing functions, which then get executed when you run `cargo test`.
-
-The `#[cfg(...)]` attribute provides [conditional compilation](https://doc.rust-lang.org/reference/conditional-compilation.html) for the item it is applied to. In this case, `#[cfg(test)]` ensures that the module is only compiled when we run `cargo test`.
-
-We import all definitions from the parent module (i.e., the `non_incremental` module) into the `test` module with `use super::*;`.
-
-In Rust, [items](https://doc.rust-lang.org/reference/items.html) — that is, functions, structs, implementations, etc. —
-can be nested inside functions. We use that in `test_require_task_direct` to scope `ReturnHelloWorld` and its implementation
-to the test function, so it can't clash with other test functions.
-
-In `execute`, we use `_context` as the parameter name for the context, as the parameter is unused.
-Unused parameters give a warning in Rust, unless it is prefixed by a `_`.
-
-[assert_eq!](https://doc.rust-lang.org/std/macro.assert_eq.html) is a [macro](https://doc.rust-lang.org/book/ch19-06-macros.html) that checks if its two expressions are equal.
-If not, it [panics](https://doc.rust-lang.org/book/ch09-01-unrecoverable-errors-with-panic.html).
-This macro is typically [used in tests](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) for assertions, as a panic marks a test as failed.
-```
-
-## Test with Multiple Tasks
-
-Our first test only tests a single task that does not use the context, so let's write a test with two tasks where one requires the other to increase our test coverage.
-Add the following test:
-
-```diff2html fromfile linebyline
-../../gen/1_programmability/2_non_incremental/e_test_problematic.rs.diff
-```
-
-We use the same `ReturnHelloWorld` task as before, but now also have a `ToLowerCase` task which requires `ReturnHelloWorld` and then turn its string lowercase.
-However, due to the way we've set up the types between `Task` and `Context`, we will run into a problem.
-Running `cargo test`, you should get these errors:
-
-```shell,
-{{#include ../../gen/1_programmability/2_non_incremental/e_cargo.txt}}
-```
-
-The problem is that `execute` of `ToLowerCase` takes a `Context`, so in `impl Task for ToLowerCase` it takes a `Context`, while we're trying to require `&ReturnHelloWorld` through the context.
-This doesn't work as `Context::require_task` only takes a `&ToLowerCase` as input.
-
-We could change `execute` of `ToLowerCase` to take `Context`:
-
-```diff2html fromfile
-../../gen/1_programmability/2_non_incremental/f_test_incompatible.rs.diff
-```
-
-But that is not allowed:
-
-```shell,
-{{#include ../../gen/1_programmability/2_non_incremental/f_cargo.txt}}
-```
-
-This is because the `Task` trait defines `execute` to take a `Context`, thus every implementation of `Task` must adhere to this, so we can't solve it this way.
-
-Effectively, due to the way we defined `Task` and `Context`, we can only use *a single task implementation*.
-This is to simplify the implementation in this tutorial, as supporting multiple task types complicates matters a lot.
-
-```admonish question title="Why only a Single Task Type?" collapsible=true
-Currently, our context is parameterized by the type of tasks: `Context`.
-Again, this is for simplicity.
-
-An incremental context wants to build a *single dependency graph* and cache task outputs, so that we can figure out from the graph whether a task is affected by a change, and just return its output if it is not affected.
-Therefore, a context implementation will maintain a `Store`.
-
-Consider the case with two different task types
-A `Context` and `Context` would then have a `Store` and `Store` respectively.
-These two stores would then maintain two different dependency graphs, one where the nodes in the graph are `ReturnHelloWorld` and one where the nodes are `ToLowerCase`.
-But that won't work, as we need a single dependency graph over all tasks to figure out what is affected.
-Therefore, we are restricted to a single task type in this tutorial.
-
-To solve this, we would need to remove the `T` generic parameter from `Context`, and instead use [trait objects](https://doc.rust-lang.org/book/ch17-02-trait-objects.html).
-However, this introduces a whole slew of problems because many traits that we use are not inherently trait-object safe.
-`Clone` is not object safe because it requires `Sized`.
-`Eq` is not object safe because it uses `Self`.
-Serializing trait objects is problematic.
-There are workarounds for all these things, but it is not pretty and very complicated.
-
-The actual PIE library supports arbitrary task types through trait objects.
-We very carefully control where generic types are introduced, and which traits need to be object-safe.
-Check out the PIE library if you want to know more!
-```
-
-For now, we will solve this by just using a single task type which is an enumeration of the different possible tasks.
-First remove the problematic test:
-
-```diff2html fromfile linebyline
-../../gen/1_programmability/2_non_incremental/g_remove_test.rs.diff
-```
-
-Then add the following test:
-
-```diff2html fromfile linebyline
-../../gen/1_programmability/2_non_incremental/h_test_correct.rs.diff
-```
-
-Here, we instead define a single task `Test` which is an `enum` with two variants.
-In its `Task` implementation, we match ourselves and return `"Hello World!"` when the variant is `ReturnHelloWorld`.
-When the variant is `ReturnHelloWorld`, we require `&Self::ReturnHelloWorld` through the context, which is now valid because it is an instance of `Test`, and turn its string lowercase and return that.
-This now works due to only having a single task type.
-Run the test with `cargo test` to confirm it is working.
-
-```admonish tip title="Rust Help: Enum" collapsible=true
-[Enums](https://doc.rust-lang.org/book/ch06-01-defining-an-enum.html) define a type by a set of variants, similar to enums in other languages, sometimes called tagged unions in other languages.
-The `match` expression matches the variant and dispatches based on that, similar to switch statements in other languages.
-```
-
-We have defined the API for the build system and implemented a non-incremental version of it.
-We're now ready to start implementing an incremental context in the next chapter.
-
-```admonish example title="Download source code" collapsible=true
-You can [download the source files up to this point](../../gen/1_programmability/2_non_incremental/source.zip).
-```
diff --git a/tutorial/src/1_programmability/index.md b/tutorial/src/1_programmability/index.md
deleted file mode 100644
index 53fa895..0000000
--- a/tutorial/src/1_programmability/index.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# Programmability
-
-In the introduction, we saw an example with _tasks_ being the unit of incremental computation, and the _context_ providing a way to create dynamic dependencies that enable incrementality.
-Those two concepts, `Task` and `Context`, are the core of a programmatic incremental build system which we will implement in this chapter.
-
-We will continue with the following steps in the next two sections:
-
-1) Create the `Task` and `Context` API, forming the core of the build system.
-2) Create a non-incremental `Context` implementation and test it against `Task` implementations, to get a feeling for the API without the complexities of incrementality.
diff --git a/tutorial/src/2_incrementality/1_require_file/a_context.rs b/tutorial/src/2_incrementality/1_require_file/a_context.rs
deleted file mode 100644
index a93e87c..0000000
--- a/tutorial/src/2_incrementality/1_require_file/a_context.rs
+++ /dev/null
@@ -1,29 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::hash::Hash;
-use std::io;
-use std::path::Path;
-
-pub mod context;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires file at given `path`, recording a dependency to it. Call this method *just before reading from the file*,
- /// so that the dependency corresponds to the data that you are reading. Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, or if there was an error opening the file.
- fn require_file>(&mut self, path: P) -> Result, io::Error>;
-
- /// Requires given `task`, recording a dependency and selectively executing it. Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output;
-}
diff --git a/tutorial/src/2_incrementality/1_require_file/b_fs_module.rs b/tutorial/src/2_incrementality/1_require_file/b_fs_module.rs
deleted file mode 100644
index d6fef75..0000000
--- a/tutorial/src/2_incrementality/1_require_file/b_fs_module.rs
+++ /dev/null
@@ -1,30 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::hash::Hash;
-use std::io;
-use std::path::Path;
-
-pub mod context;
-mod fs;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires file at given `path`, recording a dependency to it. Call this method *just before reading from the file*,
- /// so that the dependency corresponds to the data that you are reading. Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, or if there was an error opening the file.
- fn require_file>(&mut self, path: P) -> Result, io::Error>;
-
- /// Requires given `task`, recording a dependency and selectively executing it. Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output;
-}
diff --git a/tutorial/src/2_incrementality/1_require_file/c_fs.rs b/tutorial/src/2_incrementality/1_require_file/c_fs.rs
deleted file mode 100644
index d6eaab4..0000000
--- a/tutorial/src/2_incrementality/1_require_file/c_fs.rs
+++ /dev/null
@@ -1,30 +0,0 @@
-use std::{fs, io};
-use std::fs::{File, Metadata};
-use std::path::Path;
-
-/// Gets the metadata for given `path`, returning:
-/// - `Ok(Some(metadata))` if a file or directory exists at given path,
-/// - `Ok(None)` if no file or directory exists at given path,
-/// - `Err(e)` if there was an error getting the metadata for given path.
-pub fn metadata(path: impl AsRef) -> Result, io::Error> {
- match fs::metadata(path) {
- Err(e) if e.kind() == io::ErrorKind::NotFound => Ok(None),
- Err(e) => Err(e),
- Ok(m) => Ok(Some(m))
- }
-}
-
-/// Attempt to open file at given `path`, returning:
-/// - `Ok(Some(file))` if the file exists at given path,
-/// - `Ok(None)` if no file exists at given path (but a directory could exist at given path),
-/// - `Err(e)` if there was an error getting the metadata for given path, or if there was an error opening the file.
-///
-/// This function is necessary due to Windows returning an error when attempting to open a directory.
-pub fn open_if_file(path: impl AsRef) -> Result, io::Error> {
- let file = match metadata(&path)? {
- Some(metadata) if metadata.is_file() => Some(File::open(&path)?),
- _ => None,
- };
- Ok(file)
-}
-
diff --git a/tutorial/src/2_incrementality/1_require_file/d_dev_shared_Cargo.toml b/tutorial/src/2_incrementality/1_require_file/d_dev_shared_Cargo.toml
deleted file mode 100644
index 39b899f..0000000
--- a/tutorial/src/2_incrementality/1_require_file/d_dev_shared_Cargo.toml
+++ /dev/null
@@ -1,7 +0,0 @@
-[package]
-name = "dev_shared"
-version = "0.1.0"
-edition = "2021"
-
-[dependencies]
-tempfile = "3"
diff --git a/tutorial/src/2_incrementality/1_require_file/e_dev_shared_lib.rs b/tutorial/src/2_incrementality/1_require_file/e_dev_shared_lib.rs
deleted file mode 100644
index e95c308..0000000
--- a/tutorial/src/2_incrementality/1_require_file/e_dev_shared_lib.rs
+++ /dev/null
@@ -1,9 +0,0 @@
-use std::io;
-
-use tempfile::{NamedTempFile, TempDir};
-
-/// Creates a new temporary file that gets cleaned up when dropped.
-pub fn create_temp_file() -> Result { NamedTempFile::new() }
-
-/// Creates a new temporary directory that gets cleaned up when dropped.
-pub fn create_temp_dir() -> Result { TempDir::new() }
diff --git a/tutorial/src/2_incrementality/1_require_file/f_Cargo.toml b/tutorial/src/2_incrementality/1_require_file/f_Cargo.toml
deleted file mode 100644
index cca495d..0000000
--- a/tutorial/src/2_incrementality/1_require_file/f_Cargo.toml
+++ /dev/null
@@ -1,8 +0,0 @@
-[package]
-name = "pie"
-version = "0.1.0"
-edition = "2021"
-
-[dev-dependencies]
-dev_shared = { path = "../dev_shared" }
-assert_matches = "1"
diff --git a/tutorial/src/2_incrementality/1_require_file/g_fs_test.rs b/tutorial/src/2_incrementality/1_require_file/g_fs_test.rs
deleted file mode 100644
index bad8921..0000000
--- a/tutorial/src/2_incrementality/1_require_file/g_fs_test.rs
+++ /dev/null
@@ -1,55 +0,0 @@
-#[cfg(test)]
-mod test {
- use std::fs::remove_file;
- use std::io;
-
- use assert_matches::assert_matches;
-
- use dev_shared::{create_temp_dir, create_temp_file};
-
- use super::*;
-
- #[test]
- fn test_metadata_ok() -> Result<(), io::Error> {
- let temp_file = create_temp_file()?;
- let metadata = metadata(temp_file)?;
- assert_matches!(metadata, Some(metadata) => {
- assert!(metadata.is_file());
- });
- Ok(())
- }
-
- #[test]
- fn test_metadata_none() -> Result<(), io::Error> {
- let temp_file = create_temp_file()?;
- remove_file(&temp_file)?;
- let metadata = metadata(&temp_file)?;
- assert!(metadata.is_none());
- Ok(())
- }
-
- #[test]
- fn test_open_if_file() -> Result<(), io::Error> {
- let temp_file = create_temp_file()?;
- let file = open_if_file(&temp_file)?;
- assert!(file.is_some());
- Ok(())
- }
-
- #[test]
- fn test_open_if_file_non_existent() -> Result<(), io::Error> {
- let temp_file = create_temp_file()?;
- remove_file(&temp_file)?;
- let file = open_if_file(&temp_file)?;
- assert!(file.is_none());
- Ok(())
- }
-
- #[test]
- fn test_open_if_file_on_directory() -> Result<(), io::Error> {
- let temp_dir = create_temp_dir()?;
- let file = open_if_file(temp_dir)?;
- assert!(file.is_none());
- Ok(())
- }
-}
diff --git a/tutorial/src/2_incrementality/1_require_file/h_non_incremental_context.rs b/tutorial/src/2_incrementality/1_require_file/h_non_incremental_context.rs
deleted file mode 100644
index 18d7cec..0000000
--- a/tutorial/src/2_incrementality/1_require_file/h_non_incremental_context.rs
+++ /dev/null
@@ -1,19 +0,0 @@
-use std::fs::File;
-use std::io;
-use std::path::Path;
-
-use crate::{Context, Task};
-use crate::fs::open_if_file;
-
-pub struct NonIncrementalContext;
-
-impl Context for NonIncrementalContext {
- fn require_file>(&mut self, path: P) -> Result, io::Error> {
- open_if_file(&path)
- }
-
- fn require_task(&mut self, task: &T) -> T::Output {
- task.execute(self)
- }
-}
-
diff --git a/tutorial/src/2_incrementality/1_require_file/index.md b/tutorial/src/2_incrementality/1_require_file/index.md
deleted file mode 100644
index 3502a0c..0000000
--- a/tutorial/src/2_incrementality/1_require_file/index.md
+++ /dev/null
@@ -1,142 +0,0 @@
-# Requiring Files
-
-Since build systems frequently interact with files, and changes to files can affect tasks, we need to keep track of file dependencies.
-Therefore, we will extend the `Context` API with methods to *require files*, enabling tasks to specify dynamic dependencies to files.
-
-Add a method to the `Context` trait in `pie/src/lib.rs`:
-
-```diff2html fromfile
-../../gen/2_incrementality/1_require_file/a_context.rs.diff
-```
-
-`require_file` is similar to requiring a task, but instead takes a `path` to a file or directory on the filesystem as input.
-We use `AsRef` as the type for the path, so that we can pass anything in that can dereference to a path.
-For example, `str` has an `AsRef` implementation, so we can just use `"test.txt"` as a path.
-
-As an output, we return `Result, io::Error>`, with `File` being a handle to an open file.
-The reason for this complicated type is:
-
-* An incremental context will want to read the metadata (such as the last modified date) of the file, or create a hash over the file, to be able to detect changes. Because getting metadata or reading the file can fail, and we want to propagate this error, we return a `Result` with `io::Error` as the error type.
-* Tasks can create a dependency to a file that does not exist, and the existence of that file affects the task. For example, a task that prints true or false based on if a file exists. If the file does not exist (or it is a directory), we cannot open it, so we cannot return a `File`, hence we use `Option` to return `None`.
-* Otherwise, we return `Ok(Some(file))` so that the task can read the opened file.
-
-```admonish tip title="Rust Help: Error Handling with Result, Optional, AsRef Conversion" collapsible=true
-[Recoverable error handling](https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html) in Rust is done with the `Result` type, which can either be `Ok(t)` or `Err(e)`.
-In contrast to many languages which use exceptions, throwing, and exception handling; Rust treats recoverable errors just as regular values.
-
-Similarly, [optional values](https://doc.rust-lang.org/std/option/) in Rust are defined using the `Option` type, which can either be `Some(t)` or `None`.
-
-Rust has many traits for converting values or references into others, which provides a lot of convenience in what would otherwise require a lot of explicit conversions.
-[`AsRef`](https://doc.rust-lang.org/std/convert/trait.AsRef.html) is such a conversion trait, that can convert itself into `&T`.
-Here, we use `AsRef` as a generic with a trait bound to support many different kinds of values to the `path` argument in `require_file`.
-For example, we can call `context.require_file("test.txt")` because `str`, which is the type of string constants, [implements `AsRef`](https://doc.rust-lang.org/src/std/path.rs.html#3136-3141).
-You can also see this as a kind of method overloading, without having to provide concrete overloads for all supported types.
-```
-
-Now we need to implement this method for `NonIncrementalContext`.
-However, because we will be performing similar file system operations in the incremental context as well, we will create some utility functions for this first.
-
-Add the `fs` module to `pie/src/lib.rs`:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/1_require_file/b_fs_module.rs.diff
-```
-
-Create file `pie/src/fs.rs` with:
-
-```rust,
-{{#include c_fs.rs}}
-```
-
-The `metadata` function gets the filesystem metadata given a path, and `open_if_file` opens the file for given path.
-The reason for these functions is that the standard library function `std::fs::metadata` treats non-existent files as an error, whereas we don't want to treat it as an error and just return `None`.
-Furthermore, `open_if_file` works around an issue where opening a directory on Windows (and possibly other operating systems) is an error, where we want to treat it as `None` again.
-The documentation comments explain the exact behaviour.
-
-```admonish tip title="Rust Help: Error Propagation, Documentation Comments" collapsible=true
-The `?` operator makes it easy to [propgate errors](https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html#a-shortcut-for-propagating-errors-the--operator).
-Because errors are just values in Rust, to propgate an error, you'd normally have to match each result and manually propagate the error.
-The `r?` operator applied to a `Result` `r` does this for you, it basically desugars to something like `match r { Err(e) => return Err(e), _ => {} }`.
-
-Comments with three forward slashes `///` are [documentation comments](https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments) that document the function/struct/enum/trait/etc. they are applied to.
-```
-
-We will write some tests to confirm the behaviour, but for that we need utilities to create temporary files and directories.
-Furthermore, we will be writing more unit tests, integration tests, and even benchmarks in this tutorial, so we will set up these utilities in such a way that they are reachable by all these use cases.
-The only way to do that in Rust right now, is to create a separate crate and have the `pie` crate depend on it.
-
-And yes, we went from adding file dependencies, to creating file system utilities, to testing those file system utilities, to creating testing utilities, and now to making a crate for those testing utilities.
-Sorry about that 😅, we will start unwinding this stack soon!
-
-Next to the `pie` directory, create a directory named `dev_shared`.
-Create the `dev_shared/Cargo.toml` file with the following contents:
-
-```toml,
-{{#include d_dev_shared_Cargo.toml}}
-```
-
-We've added the `tempfile` dependency here already, which is a crate that creates and automatically cleans up temporary files and directories.
-
-```admonish tip title="Rust Help: Dependencies" collapsible=true
-We use other libraries (crates) by [specifying dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html).
-Because basically every Rust library adheres to [semantic versioning](https://semver.org/), we can use `"3"` as a version requirement which indicates that we will use the most up-to-date `3.x.x` version.
-```
-
-Create the main library file `dev_shared/src/lib.rs`, with functions for creating temporary files and directories:
-
-```rust,
-{{#include e_dev_shared_lib.rs}}
-```
-
-Your directory structure should now look like this:
-
-```
-{{#include ../../gen/2_incrementality/1_require_file/e_dir.txt:2:}}
-```
-
-To access these utility functions in the `pie` crate, add a dependency to `dev_shared` in `pie/Cargo.toml` along with another create that will help testing:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/1_require_file/f_Cargo.toml.diff
-```
-
-We've also added the [assert_matches](https://crates.io/crates/assert_matches) crate, which is a handy library for asserting that a value matches a pattern.
-Note that these dependencies are added under `dev-dependencies`, indicating that these dependencies are only available when running tests, benchmarks, and examples.
-Therefore, users of our library will not depend on these crates, which is good, because temporary file management and assertions are not necessary to users of the library.
-
-Back to testing our filesystem utilities.
-Add the following tests to `pie/src/fs.rs`:
-
-```rust,
-{{#include g_fs_test.rs}}
-```
-
-We test whether the functions conform to the specified behaviour.
-Unfortunately, we can't easily test when `metadata` and `open_if_file` should return an error, because we cannot disable read permissions on files via the Rust standard library.
-
-We use our `create_temp_file` and `create_temp_dir` utility functions to create temporary files and directories.
-The `tempfile` library takes care of deleting temporary files when they go out of scope (at the end of the test).
-
-We use `assert_matches!` to assert that `metadata` is `Some(metadata)`, binding `metadata` in the ` => { ... }` block in which we assert that the metadata describes a file.
-We will use this macro more in future integration tests.
-
-```admonish tip title="Rust Help: Result in Tests" collapsible=true
-Tests can [return `Result`](https://doc.rust-lang.org/book/ch11-01-writing-tests.html#using-resultt-e-in-tests).
-When a test returns an `Err`, the test fails.
-This allows us to write more concise tests using error propagation.
-```
-
-Now we are done unwinding our stack and have filesystem and testing utilities.
-Make the non-incremental context compatible by changing `pie/src/context/non_incremental.rs`:
-
-```diff2html fromfile
-../../gen/2_incrementality/1_require_file/h_non_incremental_context.rs.diff
-```
-
-Since the non-incremental context does not track anything, we only try to open the file and return it, matching the contract in the documentation comment of the `Context::require_file` trait method.
-
-Confirm everything works with `cargo test`.
-
-```admonish example title="Download source code" collapsible=true
-You can [download the source files up to this point](../../gen/2_incrementality/1_require_file/source.zip).
-```
diff --git a/tutorial/src/2_incrementality/2_stamp/a_module.rs b/tutorial/src/2_incrementality/2_stamp/a_module.rs
deleted file mode 100644
index 041597a..0000000
--- a/tutorial/src/2_incrementality/2_stamp/a_module.rs
+++ /dev/null
@@ -1,31 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::hash::Hash;
-use std::io;
-use std::path::Path;
-
-pub mod stamp;
-pub mod context;
-mod fs;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires file at given `path`, recording a dependency to it. Call this method *just before reading from the file*,
- /// so that the dependency corresponds to the data that you are reading. Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, or if there was an error opening the file.
- fn require_file>(&mut self, path: P) -> Result, io::Error>;
-
- /// Requires given `task`, recording a dependency and selectively executing it. Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output;
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/b_file.rs b/tutorial/src/2_incrementality/2_stamp/b_file.rs
deleted file mode 100644
index 202044e..0000000
--- a/tutorial/src/2_incrementality/2_stamp/b_file.rs
+++ /dev/null
@@ -1,34 +0,0 @@
-use std::fmt::Debug;
-use std::io;
-use std::path::Path;
-use std::time::SystemTime;
-
-use crate::fs::metadata;
-
-#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
-pub enum FileStamper {
- Exists,
- Modified,
-}
-
-#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
-pub enum FileStamp {
- Exists(bool),
- Modified(Option),
-}
-
-impl FileStamper {
- pub fn stamp(&self, path: impl AsRef) -> Result {
- match self {
- FileStamper::Exists => {
- Ok(FileStamp::Exists(path.as_ref().try_exists()?))
- }
- FileStamper::Modified => {
- let Some(metadata) = metadata(path)? else {
- return Ok(FileStamp::Modified(None));
- };
- Ok(FileStamp::Modified(Some(metadata.modified()?)))
- }
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/c_output.rs b/tutorial/src/2_incrementality/2_stamp/c_output.rs
deleted file mode 100644
index f49448e..0000000
--- a/tutorial/src/2_incrementality/2_stamp/c_output.rs
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
-#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
-pub enum OutputStamper {
- Inconsequential,
- Equals,
-}
-
-#[derive(Clone, Eq, PartialEq, Debug)]
-pub enum OutputStamp {
- Inconsequential,
- Equals(O),
-}
-
-impl OutputStamper {
- pub fn stamp(&self, output: O) -> OutputStamp {
- match self {
- OutputStamper::Inconsequential => OutputStamp::Inconsequential,
- OutputStamper::Equals => OutputStamp::Equals(output),
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/d1_test.rs b/tutorial/src/2_incrementality/2_stamp/d1_test.rs
deleted file mode 100644
index ad228fe..0000000
--- a/tutorial/src/2_incrementality/2_stamp/d1_test.rs
+++ /dev/null
@@ -1,58 +0,0 @@
-
-
-#[cfg(test)]
-mod test {
- use std::fs::{remove_file, write};
- use std::io;
-
- use dev_shared::create_temp_file;
-
- use super::*;
-
- #[test]
- fn test_exists_file_stamper() -> Result<(), io::Error> {
- let stamper = FileStamper::Exists;
- let temp_file = create_temp_file()?;
- let stamp = stamper.stamp(&temp_file)?;
- assert_eq!(stamp, stamper.stamp(&temp_file)?);
-
- remove_file(&temp_file)?;
- assert_ne!(stamp, stamper.stamp(&temp_file)?);
-
- Ok(())
- }
-
- #[test]
- fn test_modified_file_stamper() -> Result<(), io::Error> {
- let stamper = FileStamper::Modified;
- let temp_file = create_temp_file()?;
- let stamp = stamper.stamp(&temp_file)?;
- assert_eq!(stamp, stamper.stamp(&temp_file)?);
-
- write(&temp_file, format!("{:?}", stamp))?;
- let new_stamp = stamper.stamp(&temp_file)?;
- assert_ne!(stamp, new_stamp);
- let stamp = new_stamp;
-
- remove_file(&temp_file)?;
- assert_ne!(stamp, stamper.stamp(&temp_file)?);
-
- Ok(())
- }
-
- #[test]
- fn test_inconsequential_output_stamper() {
- let stamper = OutputStamper::Inconsequential;
- let stamp = stamper.stamp(&1);
- assert_eq!(stamp, stamper.stamp(&1));
- assert_eq!(stamp, stamper.stamp(&2));
- }
-
- #[test]
- fn test_equals_output_stamper() {
- let stamper = OutputStamper::Equals;
- let stamp = stamper.stamp(&1);
- assert_eq!(stamp, stamper.stamp(&1));
- assert_ne!(stamp, stamper.stamp(&2));
- }
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/d2_test_utilities.rs b/tutorial/src/2_incrementality/2_stamp/d2_test_utilities.rs
deleted file mode 100644
index 861ac49..0000000
--- a/tutorial/src/2_incrementality/2_stamp/d2_test_utilities.rs
+++ /dev/null
@@ -1,38 +0,0 @@
-use std::fs::{metadata, write};
-use std::io;
-use std::path::Path;
-use std::time::SystemTime;
-
-use tempfile::{NamedTempFile, TempDir};
-
-/// Creates a new temporary file that gets cleaned up when dropped.
-pub fn create_temp_file() -> Result { NamedTempFile::new() }
-
-/// Creates a new temporary directory that gets cleaned up when dropped.
-pub fn create_temp_dir() -> Result { TempDir::new() }
-
-/// Keeps writing `contents` to file at `path` until its last modified time changes, then returns the modified time.
-/// This is required because some OSs have imprecise modified timers, where the file modified time does not change when
-/// writing in quick succession.
-///
-/// # Errors
-///
-/// Returns an error when any file operation fails.
-pub fn write_until_modified(path: impl AsRef, contents: impl AsRef<[u8]>) -> Result {
- let path = path.as_ref();
- let contents = contents.as_ref();
- fn get_modified(path: impl AsRef) -> Result {
- let modified = match metadata(path) {
- Err(e) if e.kind() == io::ErrorKind::NotFound => SystemTime::UNIX_EPOCH,
- Err(e) => Err(e)?,
- Ok(m) => m.modified()?
- };
- Ok(modified)
- }
- let modified = get_modified(path)?;
- loop {
- write(path, contents)?;
- if modified != get_modified(path)? { break; }
- }
- Ok(modified)
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/d3_test_correct.rs b/tutorial/src/2_incrementality/2_stamp/d3_test_correct.rs
deleted file mode 100644
index c8f82b5..0000000
--- a/tutorial/src/2_incrementality/2_stamp/d3_test_correct.rs
+++ /dev/null
@@ -1,60 +0,0 @@
-
-
-#[cfg(test)]
-mod test {
- use std::fs::remove_file;
- use std::io;
-
- use dev_shared::{create_temp_file, write_until_modified};
-
- use super::*;
-
- #[test]
- fn test_exists_file_stamper() -> Result<(), io::Error> {
- let stamper = FileStamper::Exists;
- let temp_file = create_temp_file()?;
- let stamp = stamper.stamp(&temp_file)?;
- assert_eq!(stamp, stamper.stamp(&temp_file)?);
-
- remove_file(&temp_file)?;
- assert_ne!(stamp, stamper.stamp(&temp_file)?);
-
- Ok(())
- }
-
- #[test]
- fn test_modified_file_stamper() -> Result<(), io::Error> {
- let stamper = FileStamper::Modified;
- let temp_file = create_temp_file()?;
- let stamp = stamper.stamp(&temp_file)?;
- assert_eq!(stamp, stamper.stamp(&temp_file)?);
-
- // Write until file modified time changes. Required on some OSs due to imprecise modified timer causing the modified
- // stamp to be the same after fast consecutive writes.
- write_until_modified(&temp_file, format!("{:?}", stamp))?;
- let new_stamp = stamper.stamp(&temp_file)?;
- assert_ne!(stamp, new_stamp);
- let stamp = new_stamp;
-
- remove_file(&temp_file)?;
- assert_ne!(stamp, stamper.stamp(&temp_file)?);
-
- Ok(())
- }
-
- #[test]
- fn test_inconsequential_output_stamper() {
- let stamper = OutputStamper::Inconsequential;
- let stamp = stamper.stamp(&1);
- assert_eq!(stamp, stamper.stamp(&1));
- assert_eq!(stamp, stamper.stamp(&2));
- }
-
- #[test]
- fn test_equals_output_stamper() {
- let stamper = OutputStamper::Equals;
- let stamp = stamper.stamp(&1);
- assert_eq!(stamp, stamper.stamp(&1));
- assert_ne!(stamp, stamper.stamp(&2));
- }
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/e_context_file.rs b/tutorial/src/2_incrementality/2_stamp/e_context_file.rs
deleted file mode 100644
index 641804c..0000000
--- a/tutorial/src/2_incrementality/2_stamp/e_context_file.rs
+++ /dev/null
@@ -1,46 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::hash::Hash;
-use std::io;
-use std::path::Path;
-
-use stamp::{FileStamper, OutputStamper};
-
-pub mod stamp;
-pub mod context;
-mod fs;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires file at given `path`, recording a dependency to it (using the default require file stamper). Call this
- /// method *just before reading from the file*, so that the dependency corresponds to the data that you are reading.
- /// Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file>(&mut self, path: P) -> Result, io::Error> {
- self.require_file_with_stamper(path, self.default_require_file_stamper())
- }
- /// Requires file at given `path`, recording a dependency to it (using given `stamper`). Call this method
- /// *just before reading from the file*, so that the dependency corresponds to the data that you are reading. Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file_with_stamper>(&mut self, path: P, stamper: FileStamper) -> Result, io::Error>;
- /// Returns the default require file stamper.
- fn default_require_file_stamper(&self) -> FileStamper { FileStamper::Modified }
-
- /// Requires given `task`, recording a dependency and selectively executing it. Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output;
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/f_context_task.rs b/tutorial/src/2_incrementality/2_stamp/f_context_task.rs
deleted file mode 100644
index d6e731e..0000000
--- a/tutorial/src/2_incrementality/2_stamp/f_context_task.rs
+++ /dev/null
@@ -1,54 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::hash::Hash;
-use std::io;
-use std::path::Path;
-
-use stamp::{FileStamper, OutputStamper};
-
-pub mod stamp;
-pub mod context;
-mod fs;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires file at given `path`, recording a dependency to it (using the default require file stamper). Call this
- /// method *just before reading from the file*, so that the dependency corresponds to the data that you are reading.
- /// Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file>(&mut self, path: P) -> Result, io::Error> {
- self.require_file_with_stamper(path, self.default_require_file_stamper())
- }
- /// Requires file at given `path`, recording a dependency to it (using given `stamper`). Call this method
- /// *just before reading from the file*, so that the dependency corresponds to the data that you are reading. Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file_with_stamper>(&mut self, path: P, stamper: FileStamper) -> Result, io::Error>;
- /// Returns the default require file stamper.
- fn default_require_file_stamper(&self) -> FileStamper { FileStamper::Modified }
-
- /// Requires given `task`, recording a dependency (using the default output stamper) and selectively executing it.
- /// Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output {
- self.require_task_with_stamper(task, self.default_output_stamper())
- }
- /// Requires given `task`, recording a dependency (using given `stamper`) and selectively executing it. Returns its
- /// up-to-date output.
- fn require_task_with_stamper(&mut self, task: &T, stamper: OutputStamper) -> T::Output;
- /// Returns the default output stamper.
- fn default_output_stamper(&self) -> OutputStamper { OutputStamper::Equals }
-}
diff --git a/tutorial/src/2_incrementality/2_stamp/g_non_incremental_context.rs b/tutorial/src/2_incrementality/2_stamp/g_non_incremental_context.rs
deleted file mode 100644
index 96beaac..0000000
--- a/tutorial/src/2_incrementality/2_stamp/g_non_incremental_context.rs
+++ /dev/null
@@ -1,20 +0,0 @@
-use std::fs::File;
-use std::io;
-use std::path::Path;
-
-use crate::{Context, Task};
-use crate::fs::open_if_file;
-use crate::stamp::{FileStamper, OutputStamper};
-
-pub struct NonIncrementalContext;
-
-impl Context for NonIncrementalContext {
- fn require_file_with_stamper>(&mut self, path: P, _stamper: FileStamper) -> Result, io::Error> {
- open_if_file(&path)
- }
-
- fn require_task_with_stamper(&mut self, task: &T, _stamper: OutputStamper) -> T::Output {
- task.execute(self)
- }
-}
-
diff --git a/tutorial/src/2_incrementality/2_stamp/index.md b/tutorial/src/2_incrementality/2_stamp/index.md
deleted file mode 100644
index 1648852..0000000
--- a/tutorial/src/2_incrementality/2_stamp/index.md
+++ /dev/null
@@ -1,147 +0,0 @@
-# Stamps
-
-To check whether we need to execute a task, we need to check the dependencies of that task to see if any of them are inconsistent.
-To make this consistency checking configurable, we will use stamps.
-A dependency is inconsistent if after stamping, the new stamp is different from the old stamp.
-Therefore, we will implement a `FileStamper` that stamps files and produces a `FileStamp`, and an `OutputStamper` that stamps task outputs and produces an `OutputStamp`.
-
-Add the `stamp` module to `pie/src/lib.rs`:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/2_stamp/a_module.rs.diff
-```
-
-This module is public as users of the library will construct stampers.
-
-## File stamps
-
-Create the `pie/src/stamp.rs` file and add:
-
-```rust,
-{{#include b_file.rs}}
-```
-
-We're implementing `FileStamper` as an enum for simplicity.
-
-A `FileStamper` has a single method `stamp` which takes something that can be dereferenced to a path, and produces a `FileStamp` or an error if creating the stamp failed.
-For now, we implement only two kinds of file stampers: `Exists` and `Modified`.
-The `Exists` stamper just returns a boolean indicating whether a file exists.
-It can be used to create a file dependency where a task behaves differently based on whether a file exists or not.
-The `Modified` stamper returns the last modification date if the file exists, or `None` if the file does not exist.
-
-We derive `Eq` for stamps so that we can compare them.
-Equal (same) stamps indicate a consistent dependency, unequal (different) indicates inconsistent.
-We also derive `Eq` for stampers, because the stamper of a dependency could change, making the dependency inconsistent.
-
-## Task output stamps
-
-We implement task output stampers in a similar way.
-Add to `pie/src/stamp.rs`:
-
-```rust,
-{{#include c_output.rs:3:}}
-```
-
-The `Inconsequential` stamper simply ignores the output and always returns the same stamp (thus is always equal).
-It can be used to create a task dependency where we are interested in some side effect of a task, but don't care about its output.
-The `Equals` stamper simply wraps the output of a task, so the stamp is equal when the output is equal.
-
-Output stamps are generic over the task output type `O`.
-
-```admonish tip title="Trait Bounds and Derive Macros" collapsible=true
-Because `O` is used in the enum, the `derive` attributes on `OutputStamp` create bounds over `O`.
-Thus, `OutputStamp` is only `Clone` when `O` is `Clone`, `OutputStamp` is only `Eq` when `O` is `Eq`, and so forth.
-Because we declared `Task::Output` with bound `Clone + Eq + Debug`, we can be sure that `OutputStamp` is always `Clone`, `Eq`, and `Debug`.
-```
-
-```admonish question title="User-Defined Stamps?" collapsible=true
-`FileStamper` and `OutputStamper` could also be a trait which would allow users of the library to implement their own stampers.
-For simplicity, we do not explore that option in this tutorial.
-In the actual PIE library, stampers (called checkers) can be implemented by users of the library!
-```
-
-## Tests
-
-Finally, we write some tests.
-Add to `pie/src/stamp.rs`:
-
-```rust,
-{{#include d1_test.rs:3:}}
-```
-
-We test file stamps by creating a stamp, changing the file, creating a new stamp, and then compare the stamps.
-We test task output stamps by just passing a different output value to the `stamp` function, and then compare the stamps.
-
-Run `cargo test` to test the stamp implementation.
-However, a test could fail on some operating systems.
-Do continue to the next subsection if this happens.
-
-```admonish warning title="Likely Test Failure"
-Test `test_modified_file_stamper` will likely fail. Do continue to the next subsection, because we're going to fix it!
-```
-
-## Testing with file modified time, correctly
-
-Unfortunately, these tests may fail on some operating systems (Linux and Windows in my testing), due to an imprecise file last modified timer.
-What can happen is that we write to a file, making the OS update its modified time to `1000` (as an example, not a real timestamp), then very quickly write to the file again, making the OS update its modified time to `1000` again.
-Then, our test will fail because the stamp didn't change even though we expect it to change.
-
-This can happen with an imprecise timer that only increases once every millisecond (again, an example, not a real number) when we perform writes in between that millisecond.
-Even worse, our test can be flaky, sometimes succeeding if we write in between those milliseconds, sometimes failing if we write within a millisecond.
-
-To solve this, add a function to the filesystem testing utility crate.
-Change `dev_shared/src/lib.rs`:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/2_stamp/d2_test_utilities.rs.diff
-```
-
-The `write_until_modified` function writes to the file, but ensures its modified time will change.
-Now change the tests in `pie/src/stamp.rs` to use this function:
-
-```diff2html fromfile
-../../gen/2_incrementality/2_stamp/d3_test_correct.rs.diff
-```
-
-Now we use `write_until_modified` to write to the file, ensuring its modified time will change, ensuring the stamp will change when it should.
-Run `cargo test` to confirm the stamp implementation, which should succeed now.
-
-```admonish success title="Fixed Tests"
-Test `test_modified_file_stamper` should now succeed.
-```
-
-## Stamps in Context
-
-We now have a module dedicated to stamps.
-However, stampers are constructed by users of the library that author tasks, and they need to pass in these stampers when creating dependencies.
-Therefore, we need to update the `Context` trait to allow passing in these stampers.
-
-Change `Context` in `pie/src/lib.rs`:
-
-```diff2html fromfile
-../../gen/2_incrementality/2_stamp/e_context_file.rs.diff
-```
-
-We add the `require_file_with_stamper` method which allow passing in a stamper.
-We add a default implementation for `require_file` that passes in a default stamper.
-The default is provided by `default_require_file_stamper` which can be overridden by context implementations.
-
-Now apply the same to tasks, changing `Context` again in `pie/src/lib.rs`:
-
-```diff2html fromfile
-../../gen/2_incrementality/2_stamp/f_context_task.rs.diff
-```
-
-Update `NonIncrementalContext` in `src/context/non_incremental.rs` to implement the new methods:
-
-```diff2html fromfile
-../../gen/2_incrementality/2_stamp/g_non_incremental_context.rs.diff
-```
-
-We just ignore the stampers in `NonIncrementalContext`, as they are only needed for incrementality.
-
-Run `cargo test` to confirm everything still works.
-
-```admonish example title="Download source code" collapsible=true
-You can [download the source files up to this point](../../gen/2_incrementality/2_stamp/source.zip).
-```
diff --git a/tutorial/src/2_incrementality/3_dependency/a_module.rs b/tutorial/src/2_incrementality/3_dependency/a_module.rs
deleted file mode 100644
index 5abe3c3..0000000
--- a/tutorial/src/2_incrementality/3_dependency/a_module.rs
+++ /dev/null
@@ -1,55 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::hash::Hash;
-use std::io;
-use std::path::Path;
-
-use stamp::{FileStamper, OutputStamper};
-
-pub mod stamp;
-pub mod dependency;
-pub mod context;
-mod fs;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires file at given `path`, recording a dependency to it (using the default require file stamper). Call this
- /// method *just before reading from the file*, so that the dependency corresponds to the data that you are reading.
- /// Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file>(&mut self, path: P) -> Result, io::Error> {
- self.require_file_with_stamper(path, self.default_require_file_stamper())
- }
- /// Requires file at given `path`, recording a dependency to it (using given `stamper`). Call this method
- /// *just before reading from the file*, so that the dependency corresponds to the data that you are reading. Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file_with_stamper>(&mut self, path: P, stamper: FileStamper) -> Result, io::Error>;
- /// Returns the default require file stamper.
- fn default_require_file_stamper(&self) -> FileStamper { FileStamper::Modified }
-
- /// Requires given `task`, recording a dependency (using the default output stamper) and selectively executing it.
- /// Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output {
- self.require_task_with_stamper(task, self.default_output_stamper())
- }
- /// Requires given `task`, recording a dependency (using given `stamper`) and selectively executing it. Returns its
- /// up-to-date output.
- fn require_task_with_stamper(&mut self, task: &T, stamper: OutputStamper) -> T::Output;
- /// Returns the default output stamper.
- fn default_output_stamper(&self) -> OutputStamper { OutputStamper::Equals }
-}
diff --git a/tutorial/src/2_incrementality/3_dependency/b_file.rs b/tutorial/src/2_incrementality/3_dependency/b_file.rs
deleted file mode 100644
index 4709511..0000000
--- a/tutorial/src/2_incrementality/3_dependency/b_file.rs
+++ /dev/null
@@ -1,62 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::io;
-use std::path::PathBuf;
-
-use crate::{Context, Task};
-use crate::fs::open_if_file;
-use crate::stamp::{FileStamp, FileStamper, OutputStamp, OutputStamper};
-
-#[derive(Clone, Eq, PartialEq, Debug)]
-pub struct FileDependency {
- path: PathBuf,
- stamper: FileStamper,
- stamp: FileStamp,
-}
-
-impl FileDependency {
- /// Creates a new file dependency with `path` and `stamper`, returning:
- /// - `Ok(file_dependency)` normally,
- /// - `Err(e)` if stamping failed.
- #[allow(dead_code)]
- pub fn new(path: impl Into, stamper: FileStamper) -> Result {
- let path = path.into();
- let stamp = stamper.stamp(&path)?;
- let dependency = FileDependency { path, stamper, stamp };
- Ok(dependency)
- }
- /// Creates a new file dependency with `path` and `stamper`, returning:
- /// - `Ok((file_dependency, Some(file)))` if a file exists at given path,
- /// - `Ok((file_dependency, None))` if no file exists at given path (but a directory could exist at given path),
- /// - `Err(e)` if stamping or opening the file failed.
- pub fn new_with_file(path: impl Into, stamper: FileStamper) -> Result<(Self, Option), io::Error> {
- let path = path.into();
- let stamp = stamper.stamp(&path)?;
- let file = open_if_file(&path)?;
- let dependency = FileDependency { path, stamper, stamp };
- Ok((dependency, file))
- }
-
- /// Returns the path of this dependency.
- #[allow(dead_code)]
- pub fn path(&self) -> &PathBuf { &self.path }
- /// Returns the stamper of this dependency.
- #[allow(dead_code)]
- pub fn stamper(&self) -> &FileStamper { &self.stamper }
- /// Returns the stamp of this dependency.
- #[allow(dead_code)]
- pub fn stamp(&self) -> &FileStamp { &self.stamp }
-
- /// Checks whether this file dependency is inconsistent, returning:
- /// - `Ok(Some(stamp))` if this dependency is inconsistent (with `stamp` being the new stamp of the dependency),
- /// - `Ok(None)` if this dependency is consistent,
- /// - `Err(e)` if there was an error checking this dependency for consistency.
- pub fn is_inconsistent(&self) -> Result, io::Error> {
- let new_stamp = self.stamper.stamp(&self.path)?;
- if new_stamp == self.stamp {
- Ok(None)
- } else {
- Ok(Some(new_stamp))
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/3_dependency/c_task.rs b/tutorial/src/2_incrementality/3_dependency/c_task.rs
deleted file mode 100644
index d0bacb9..0000000
--- a/tutorial/src/2_incrementality/3_dependency/c_task.rs
+++ /dev/null
@@ -1,39 +0,0 @@
-
-
-#[derive(Clone, Eq, PartialEq, Debug)]
-pub struct TaskDependency {
- task: T,
- stamper: OutputStamper,
- stamp: OutputStamp,
-}
-
-impl TaskDependency {
- /// Creates a new `task` dependency with `stamper` and `output`.
- pub fn new(task: T, stamper: OutputStamper, output: T::Output) -> Self {
- let stamp = stamper.stamp(output);
- Self { task, stamper, stamp }
- }
-
- /// Returns the task of this dependency.
- #[allow(dead_code)]
- pub fn task(&self) -> &T { &self.task }
- /// Returns the stamper of this dependency.
- #[allow(dead_code)]
- pub fn stamper(&self) -> &OutputStamper { &self.stamper }
- /// Returns the stamp of this dependency.
- #[allow(dead_code)]
- pub fn stamp(&self) -> &OutputStamp { &self.stamp }
-
- /// Checks whether this task dependency is inconsistent, returning:
- /// - `Some(stamp)` if this dependency is inconsistent (with `stamp` being the new stamp of the dependency),
- /// - `None` if this dependency is consistent.
- pub fn is_inconsistent>(&self, context: &mut C) -> Option> {
- let output = context.require_task(&self.task);
- let new_stamp = self.stamper.stamp(output);
- if new_stamp == self.stamp {
- None
- } else {
- Some(new_stamp)
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/3_dependency/d_dependency.rs b/tutorial/src/2_incrementality/3_dependency/d_dependency.rs
deleted file mode 100644
index 2de2dcf..0000000
--- a/tutorial/src/2_incrementality/3_dependency/d_dependency.rs
+++ /dev/null
@@ -1,29 +0,0 @@
-
-
-#[derive(Clone, Eq, PartialEq, Debug)]
-pub enum Dependency {
- RequireFile(FileDependency),
- RequireTask(TaskDependency),
-}
-
-#[derive(Clone, Eq, PartialEq, Debug)]
-pub enum Inconsistency {
- File(FileStamp),
- Task(OutputStamp),
-}
-
-impl Dependency {
- /// Checks whether this dependency is inconsistent, returning:
- /// - `Ok(Some(stamp))` if the dependency is inconsistent (with `stamp` being the new stamp of the dependency),
- /// - `Ok(None)` if the dependency is consistent,
- /// - `Err(e)` if there was an error checking the dependency for consistency.
- pub fn is_inconsistent>(&self, context: &mut C) -> Result>, io::Error> {
- let option = match self {
- Dependency::RequireFile(d) => d.is_inconsistent()?
- .map(|s| Inconsistency::File(s)),
- Dependency::RequireTask(d) => d.is_inconsistent(context)
- .map(|s| Inconsistency::Task(s)),
- };
- Ok(option)
- }
-}
diff --git a/tutorial/src/2_incrementality/3_dependency/e_test.rs b/tutorial/src/2_incrementality/3_dependency/e_test.rs
deleted file mode 100644
index 80554a3..0000000
--- a/tutorial/src/2_incrementality/3_dependency/e_test.rs
+++ /dev/null
@@ -1,72 +0,0 @@
-
-
-#[cfg(test)]
-mod test {
- use std::fs::write;
- use std::io::{self, Read};
-
- use dev_shared::{create_temp_file, write_until_modified};
-
- use crate::context::non_incremental::NonIncrementalContext;
-
- use super::*;
-
- /// Task that reads file at given path and returns it contents as a string.
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct ReadStringFromFile(PathBuf);
-
- impl Task for ReadStringFromFile {
- type Output = String;
- fn execute>(&self, context: &mut C) -> Self::Output {
- let mut string = String::new();
- let file = context.require_file(&self.0).expect("failed to require file");
- if let Some(mut file) = file {
- file.read_to_string(&mut string).expect("failed to read from file");
- };
- string
- }
- }
-
- #[test]
- fn test_file_dependency_consistency() -> Result<(), io::Error> {
- let mut context = NonIncrementalContext;
-
- let temp_file = create_temp_file()?;
- write(&temp_file, "test1")?;
-
- let file_dependency = FileDependency::new(temp_file.path(), FileStamper::Modified)?;
- let dependency: Dependency = Dependency::RequireFile(file_dependency.clone());
- assert!(file_dependency.is_inconsistent()?.is_none());
- assert!(dependency.is_inconsistent(&mut context)?.is_none());
-
- // Change the file, changing the stamp the stamper will create next time, making the file dependency inconsistent.
- write_until_modified(&temp_file, "test2")?;
- assert!(file_dependency.is_inconsistent()?.is_some());
- assert!(dependency.is_inconsistent(&mut context)?.is_some());
-
- Ok(())
- }
-
- #[test]
- fn test_task_dependency_consistency() -> Result<(), io::Error> {
- let mut context = NonIncrementalContext;
-
- let temp_file = create_temp_file()?;
- write(&temp_file, "test1")?;
- let task = ReadStringFromFile(temp_file.path().to_path_buf());
- let output = context.require_task(&task);
-
- let task_dependency = TaskDependency::new(task.clone(), OutputStamper::Equals, output);
- let dependency = Dependency::RequireTask(task_dependency.clone());
- assert!(task_dependency.is_inconsistent(&mut context).is_none());
- assert!(dependency.is_inconsistent(&mut context)?.is_none());
-
- // Change the file, causing the task to return a different output, changing the stamp the stamper will create next
- // time, making the task dependency inconsistent.
- write_until_modified(&temp_file, "test2")?;
- assert!(task_dependency.is_inconsistent(&mut context).is_some());
- assert!(dependency.is_inconsistent(&mut context)?.is_some());
-
- Ok(())
- }
-}
diff --git a/tutorial/src/2_incrementality/3_dependency/index.md b/tutorial/src/2_incrementality/3_dependency/index.md
deleted file mode 100644
index 801934a..0000000
--- a/tutorial/src/2_incrementality/3_dependency/index.md
+++ /dev/null
@@ -1,145 +0,0 @@
-# Dynamic Dependencies
-
-Now that we've implemented stamps, we can implement dynamic dependencies and their consistency checking.
-A dependency is inconsistent if after stamping, the new stamp is different from the old stamp.
-Therefore, dependencies need to keep track of their stamper and their previous stamp.
-To that end, we will implement the `FileDependency` and `TaskDependency` types with methods for consistency checking.
-We will also implement a `Dependency` type that abstracts over `FileDependency` and `TaskDependency`, which we will need for the dependency graph implementation in the next chapter.
-
-Add the `dependency` module to `pie/src/lib.rs`:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/3_dependency/a_module.rs.diff
-```
-
-Users of the library will not construct dependencies.
-They will create dependencies (and choose stampers) via `Context` methods.
-However, dependencies will be used in the public API for debug logging later, so we make the module public.
-
-## File dependencies
-
-Create the `pie/src/dependency.rs` file and add:
-
-```rust,
-{{#include b_file.rs}}
-```
-
-A `FileDependency` stores the `path` the dependency is about, the `stamper` used to create a stamp for this dependency, and the `stamp` that was created at the time the file dependency was made.
-The `FileDependency::new_with_file` function also returns the opened file if it exists, so that users of this function can read from the file without having to open it again.
-We add getter methods to get parts of the file dependency without allowing mutation.
-Since we will use those getter methods later, we annotate them with `#[allow(dead_code)]` to disable unused warnings.
-
-A file dependency is inconsistent when the stored stamp is not equal to a stamp that we create at the time of checking, implemented in `FileDependency::is_inconsistent`.
-For example, if we created a file dependency (with modified stamper) for a file that was modified yesterday, then modify the file, and then call `is_inconsistent` on the file dependency, it would return `Some(new_stamp)` indicating that the dependency is inconsistent.
-
-We implement an `is_inconsistent` method here instead of an `is_consistent` method, so that we can return the changed stamp when the dependency is inconsistent, which we will use for debug logging purposes later.
-
-Creating and checking a file dependency can fail due to file operations failing (for example, cannot access the file), so we propagate those errors.
-
-## Task dependencies
-
-Task dependencies are implemented in a similar way.
-Add to `pie/src/dependency.rs`:
-
-```rust,
-{{#include c_task.rs:3:}}
-```
-
-A `TaskDependency` stores the `task` the dependency is about, along with its `stamper` and `stamp` that is created when the dependency is created.
-Task dependencies are generic over the type of tasks `T`, and their type of outputs `O`.
-We also add immutable getters here.
-
-```admonish question title="Why not a Trait Bound on TaskDependency?" collapsible=true
-We chose not to put a `Task` trait bound on `TaskDependency`, and instead put the bound on the impl.
-There are several up and downsides that should be considered when making such a decision.
-
-The main upside for putting the `Task` bound on the `TaskDependency` struct, is that we can leave out `O` and use `OutputStamp` as the type of the `stamp` field.
-This cuts down a generic parameter, which reduces boilerplate.
-The downside is that we need to then put the `Task` bound on every struct that uses `TaskDependency`, which increases boilerplate.
-
-In this case, we chose not to put the trait bound on the struct to prevent that trait bound from bubbling up into other structs that use `TaskDependency`, as it would need to appear in almost every struct in the library.
-```
-
-A task dependency is inconsistent if, after recursively checking it, its stamp has changed, implemented in `TaskDependency::is_inconsistent`.
-Usually, this will be using the `Equals` task output stamper, so a task dependency is usually inconsistent when the output of the task changes.
-Because we need to recursively check the task, `TaskDependency::is_inconsistent` requires a context to be passed in.
-Again, there is more mutual recursion here.
-
-This recursive consistency checking is one of the core ideas that make programmatic incremental build systems possible.
-But why is this so important? Why do we need recursive checking?
-Well, we want our build system to be *sound*, meaning that we must execute *all* tasks that are affected by a change.
-When we *do not execute* a task that *is affected by a change*, we are *unsound*, and introduce an *incrementality bug*!
-
-Because of dynamic dependencies, a change in a leaf in the dependency tree may affect a task at the root.
-For example, a compilation task depends on a task that reads a configuration file, which depends on the configuration file.
-A change to a configuration file (leaf) affects a task that reads the configuration file, which in turn affects the compilation task (root).
-Therefore, we need to recursively check the dependency tree in order to execute all tasks affected by changes.
-
-A different way to think about this, is to think about the invariant of the dependency consistency checking.
-The invariant is that a dependency is consistent if and only if the subtree of that dependency is consistent, and the dependency itself is consistent.
-The easiest way to adhere to this invariant, is recursive checking.
-
-A final note about recursive checking is that tasks can be executed during it, and executing task can lead to new dynamic dependencies.
-However, recursive checking handles this without problems because these dependencies are created through the `Context`, which in turn will call `is_inconsistent` when needed.
-
-## Dependency enum
-
-Finally, we create a `Dependency` enum that abstracts over these two kinds of dependencies.
-Add to `pie/src/dependency.rs`:
-
-```rust,
-{{#include d_dependency.rs:3:}}
-```
-
-`Dependency` just merges the two kinds of dependencies and provides an `is_inconsistent` method that calls the corresponding method.
-We return the changed stamp here as well for debug logging later.
-We wrap the changed stamp in an `Inconsistency` enum, and map to the correct variant if there is an inconsistency.
-
-Because `Dependency` can store a `TaskDependency`, we need to propagate the `T` and `O` generics.
-Likewise, `Inconsistency` propagates the `O` generic for `OutputStamp`.
-
-```admonish question title="User-Defined Dependencies?" collapsible=true
-Like with stampers, `Dependency` could also be a trait to allow users of the library to define their own dependencies.
-However, there are two requirements that make it hard to define such a trait:
-
-1) We can implement different `Context`s which treat some dependencies differently.
-For example, in the actual PIE library, we have a bottom-up context that schedules tasks from the bottom-up.
-This bottom-up context treats file and task dependencies in a completely different way compared to the top-down context.
-2) Dynamic dependencies also require validation to ensure correctness, which we will do later on in the tutorial.
-
-It is currently unclear to me how to create a `Dependency` trait with these requirements in mind.
-```
-
-## Tests
-
-As usual, we write some tests to confirm the behaviour.
-Add tests to `pie/src/dependency.rs`:
-
-```rust,
-{{#include e_test.rs:3:}}
-```
-
-We test a file dependency by asserting that `is_inconsistent` returns `Some` after changing the file.
-
-Testing task dependencies requires a bit more work.
-We create task `ReadStringFromFile` that reads a string from a file, and then returns that string as output.
-We require the task to get its output (`"test1"`), and create a task dependency with it.
-Then, we change the file and check consistency of the task dependency.
-That recursively requires the task, the context will execute the task, and the task now returns (`"test2"`).
-Since we use the `Equals` output stamper, and `"test1"` does not equal `"test2"`, the dependency is inconsistent and returns a stamp containing `"test2"`.
-
-Note that we are both testing the specific dependencies (`FileDependency` and `TaskDependency`), and the general `Dependency`.
-
-```admonish note
-Normally, a task such as `ReadStringFromFile` shound return a `Result`, but for testing purposes we are just using panics with `expect`.
-
-In the file dependency case, using `Dependency` requires an explicit type annotation because there is no task to infer the type from.
-We just use `Dependency` as the type, and this is fine even though we don't use `ReadStringFromFile` in that test, because the `Dependency::RequireFile` variant does not use those types.
-```
-
-Run `cargo test` to confirm everything still works.
-You will get some warnings about unused things, but that is ok as we will use them in the next section.
-
-```admonish example title="Download source code" collapsible=true
-You can [download the source files up to this point](../../gen/2_incrementality/3_dependency/source.zip).
-```
diff --git a/tutorial/src/2_incrementality/4_store/a_Cargo.toml b/tutorial/src/2_incrementality/4_store/a_Cargo.toml
deleted file mode 100644
index 5c63557..0000000
--- a/tutorial/src/2_incrementality/4_store/a_Cargo.toml
+++ /dev/null
@@ -1,11 +0,0 @@
-[package]
-name = "pie"
-version = "0.1.0"
-edition = "2021"
-
-[dependencies]
-%%%PIE_GRAPH_DEPENDENCY%%%
-
-[dev-dependencies]
-dev_shared = { path = "../dev_shared" }
-assert_matches = "1"
diff --git a/tutorial/src/2_incrementality/4_store/b_module.rs b/tutorial/src/2_incrementality/4_store/b_module.rs
deleted file mode 100644
index 9321fec..0000000
--- a/tutorial/src/2_incrementality/4_store/b_module.rs
+++ /dev/null
@@ -1,56 +0,0 @@
-use std::fmt::Debug;
-use std::fs::File;
-use std::hash::Hash;
-use std::io;
-use std::path::Path;
-
-use stamp::{FileStamper, OutputStamper};
-
-pub mod stamp;
-pub mod dependency;
-pub mod context;
-mod fs;
-mod store;
-
-/// A unit of computation in a programmatic incremental build system.
-pub trait Task: Clone + Eq + Hash + Debug {
- /// Type of output this task returns when executed.
- type Output: Clone + Eq + Debug;
- /// Execute the task, using `context` to specify dynamic dependencies, returning `Self::Output`.
- fn execute>(&self, context: &mut C) -> Self::Output;
-}
-
-/// Programmatic incremental build context, enabling tasks to create dynamic dependencies that context implementations
-/// use for incremental execution.
-pub trait Context {
- /// Requires file at given `path`, recording a dependency to it (using the default require file stamper). Call this
- /// method *just before reading from the file*, so that the dependency corresponds to the data that you are reading.
- /// Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file>(&mut self, path: P) -> Result, io::Error> {
- self.require_file_with_stamper(path, self.default_require_file_stamper())
- }
- /// Requires file at given `path`, recording a dependency to it (using given `stamper`). Call this method
- /// *just before reading from the file*, so that the dependency corresponds to the data that you are reading. Returns:
- /// - `Ok(Some(file))` if a file exists at given `path`,
- /// - `Ok(None)` if no file exists at given `path` (but a directory could exist at given `path`),
- /// - `Err(e)` if there was an error getting the metadata for given `path`, if there was an error opening the file, or
- /// if there was an error stamping the file.
- fn require_file_with_stamper>(&mut self, path: P, stamper: FileStamper) -> Result, io::Error>;
- /// Returns the default require file stamper.
- fn default_require_file_stamper(&self) -> FileStamper { FileStamper::Modified }
-
- /// Requires given `task`, recording a dependency (using the default output stamper) and selectively executing it.
- /// Returns its up-to-date output.
- fn require_task(&mut self, task: &T) -> T::Output {
- self.require_task_with_stamper(task, self.default_output_stamper())
- }
- /// Requires given `task`, recording a dependency (using given `stamper`) and selectively executing it. Returns its
- /// up-to-date output.
- fn require_task_with_stamper(&mut self, task: &T, stamper: OutputStamper) -> T::Output;
- /// Returns the default output stamper.
- fn default_output_stamper(&self) -> OutputStamper { OutputStamper::Equals }
-}
diff --git a/tutorial/src/2_incrementality/4_store/c_basic.rs b/tutorial/src/2_incrementality/4_store/c_basic.rs
deleted file mode 100644
index 3b99ff2..0000000
--- a/tutorial/src/2_incrementality/4_store/c_basic.rs
+++ /dev/null
@@ -1,29 +0,0 @@
-use std::path::{Path, PathBuf};
-
-use pie_graph::{DAG, Node};
-
-use crate::dependency::{Dependency, FileDependency, TaskDependency};
-use crate::Task;
-
-/// Stores files and tasks, and their dependencies, in a DAG (directed acyclic graph). Provides operations to mutate
-/// and query this graph.
-pub struct Store {
- graph: DAG, Dependency>,
-}
-
-#[derive(Debug)]
-enum NodeData {
- File(PathBuf),
- Task {
- task: T,
- output: Option,
- },
-}
-
-impl Default for Store {
- fn default() -> Self {
- Self {
- graph: DAG::default(),
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/d1_mapping_diff.rs b/tutorial/src/2_incrementality/4_store/d1_mapping_diff.rs
deleted file mode 100644
index 1bd2db6..0000000
--- a/tutorial/src/2_incrementality/4_store/d1_mapping_diff.rs
+++ /dev/null
@@ -1,34 +0,0 @@
-use std::collections::HashMap;
-use std::path::{Path, PathBuf};
-
-use pie_graph::{DAG, Node};
-
-use crate::dependency::{Dependency, FileDependency, TaskDependency};
-use crate::Task;
-
-/// Stores files and tasks, and their dependencies, in a DAG (directed acyclic graph). Provides operations to mutate
-/// and query this graph.
-pub struct Store {
- graph: DAG, Dependency>,
- file_to_node: HashMap,
- task_to_node: HashMap,
-}
-
-#[derive(Debug)]
-enum NodeData {
- File(PathBuf),
- Task {
- task: T,
- output: Option,
- },
-}
-
-impl Default for Store {
- fn default() -> Self {
- Self {
- graph: DAG::default(),
- file_to_node: HashMap::default(),
- task_to_node: HashMap::default(),
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/d2_mapping_diff.rs b/tutorial/src/2_incrementality/4_store/d2_mapping_diff.rs
deleted file mode 100644
index 2284a4d..0000000
--- a/tutorial/src/2_incrementality/4_store/d2_mapping_diff.rs
+++ /dev/null
@@ -1,53 +0,0 @@
-use std::borrow::Borrow;
-use std::collections::HashMap;
-use std::path::{Path, PathBuf};
-
-use pie_graph::{DAG, Node};
-
-use crate::dependency::{Dependency, FileDependency, TaskDependency};
-use crate::Task;
-
-/// Stores files and tasks, and their dependencies, in a DAG (directed acyclic graph). Provides operations to mutate
-/// and query this graph.
-pub struct Store {
- graph: DAG, Dependency>,
- file_to_node: HashMap,
- task_to_node: HashMap,
-}
-
-#[derive(Debug)]
-enum NodeData {
- File(PathBuf),
- Task {
- task: T,
- output: Option,
- },
-}
-
-/// Newtype for file `Node`s.
-#[repr(transparent)]
-#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
-pub struct FileNode(Node);
-
-impl Borrow for &FileNode {
- fn borrow(&self) -> &Node { &self.0 }
-}
-
-/// Newtype for task `Node`s.
-#[repr(transparent)]
-#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
-pub struct TaskNode(Node);
-
-impl Borrow for &TaskNode {
- fn borrow(&self) -> &Node { &self.0 }
-}
-
-impl Default for Store {
- fn default() -> Self {
- Self {
- graph: DAG::default(),
- file_to_node: HashMap::default(),
- task_to_node: HashMap::default(),
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/e_mapping.rs b/tutorial/src/2_incrementality/4_store/e_mapping.rs
deleted file mode 100644
index 7f70cce..0000000
--- a/tutorial/src/2_incrementality/4_store/e_mapping.rs
+++ /dev/null
@@ -1,53 +0,0 @@
-
-impl Store {
- /// Gets the file node for `path`, or creates a file node by adding it to the dependency graph.
- pub fn get_or_create_file_node(&mut self, path: impl AsRef) -> FileNode {
- let path = path.as_ref();
- if let Some(file_node) = self.file_to_node.get(path) {
- *file_node
- } else {
- let node = self.graph.add_node(NodeData::File(path.to_path_buf()));
- let node = FileNode(node);
- self.file_to_node.insert(path.to_path_buf(), node);
- node
- }
- }
- /// Gets the path for `node`.
- ///
- /// # Panics
- ///
- /// Panics if `node` was not found in the dependency graph.
- #[allow(dead_code)]
- pub fn get_file_path(&self, node: &FileNode) -> &PathBuf {
- let Some(NodeData::File(path)) = self.graph.get_node_data(node) else {
- panic!("BUG: node {:?} was not found in the dependency graph", node);
- };
- path
- }
-
- /// Gets the task node for `task`, or creates a task node by adding it to the dependency graph.
- pub fn get_or_create_task_node(&mut self, task: &T) -> TaskNode {
- if let Some(node) = self.task_to_node.get(task) {
- *node
- } else {
- let node = self.graph.add_node(NodeData::Task {
- task: task.clone(),
- output: None,
- });
- let node = TaskNode(node);
- self.task_to_node.insert(task.clone(), node);
- node
- }
- }
- /// Gets the task for `node`.
- ///
- /// # Panics
- ///
- /// Panics if `node` was not found in the dependency graph.
- pub fn get_task(&self, node: &TaskNode) -> &T {
- let Some(NodeData::Task { task, .. }) = self.graph.get_node_data(node) else {
- panic!("BUG: node {:?} was not found in the dependency graph", node);
- };
- task
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/f_output.rs b/tutorial/src/2_incrementality/4_store/f_output.rs
deleted file mode 100644
index 4fd3bd9..0000000
--- a/tutorial/src/2_incrementality/4_store/f_output.rs
+++ /dev/null
@@ -1,36 +0,0 @@
-
-impl Store {
- /// Checks whether task `node` has an output. Returns `false` if `node` does not have an output.
- ///
- /// # Panics
- ///
- /// Panics if `node` was not found in the dependency graph.
- pub fn task_has_output(&self, node: &TaskNode) -> bool {
- let Some(NodeData::Task { output, .. }) = self.graph.get_node_data(node) else {
- panic!("BUG: node {:?} was not found in the dependency graph", node);
- };
- output.is_some()
- }
- /// Gets the output for task `node`.
- ///
- /// # Panics
- ///
- /// Panics if `node` was not found in the dependency graph, or if the task has no output.
- pub fn get_task_output(&self, node: &TaskNode) -> &T::Output {
- let Some(NodeData::Task { output: Some(output), .. }) = self.graph.get_node_data(node) else {
- panic!("BUG: node {:?} was not found in the dependency graph, or does not have an output", node);
- };
- output
- }
- /// Sets the output for task `node` to `new_output`.
- ///
- /// # Panics
- ///
- /// Panics if task `node` was not found in the dependency graph.
- pub fn set_task_output(&mut self, node: &TaskNode, new_output: T::Output) {
- let Some(NodeData::Task { output, .. }) = self.graph.get_node_data_mut(node) else {
- panic!("BUG: node {:?} was not found in the dependency graph", node);
- };
- output.replace(new_output);
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/g_dependency.rs b/tutorial/src/2_incrementality/4_store/g_dependency.rs
deleted file mode 100644
index 9560c76..0000000
--- a/tutorial/src/2_incrementality/4_store/g_dependency.rs
+++ /dev/null
@@ -1,40 +0,0 @@
-
-impl Store {
- /// Get all dependencies of task `src`.
- ///
- /// # Panics
- ///
- /// Panics in development builds if `src` was not found in the dependency graph.
- pub fn get_dependencies_of_task<'a>(&'a self, src: &'a TaskNode) -> impl Iterator> + 'a {
- debug_assert!(self.graph.contains_node(src), "BUG: node {:?} was not found in the dependency graph", src);
- self.graph.get_outgoing_edge_data(src)
- }
- /// Add a file require `dependency` from task `src` to file `dst`.
- ///
- /// # Panics
- ///
- /// Panics if `src` or `dst` were not found in the dependency graph, or if a cycle is created by adding this dependency.
- pub fn add_file_require_dependency(&mut self, src: &TaskNode, dst: &FileNode, dependency: FileDependency) {
- match self.graph.add_edge(src, dst, Dependency::RequireFile(dependency)) {
- Err(pie_graph::Error::NodeMissing) => panic!("BUG: source node {:?} or destination node {:?} was not found in the dependency graph", src, dst),
- Err(pie_graph::Error::CycleDetected) => panic!("BUG: cycle detected when adding file dependency from {:?} to {:?}", src, dst),
- _ => {},
- }
- }
- /// Adds a task require `dependency` from task `src` to task `dst`.
- ///
- /// # Errors
- ///
- /// Returns `Err(())` if adding this dependency to the graph creates a cycle.
- ///
- /// # Panics
- ///
- /// Panics if `src` or `dst` were not found in the dependency graph.
- pub fn add_task_require_dependency(&mut self, src: &TaskNode, dst: &TaskNode, dependency: TaskDependency) -> Result<(), ()> {
- match self.graph.add_edge(src, dst, Dependency::RequireTask(dependency)) {
- Err(pie_graph::Error::NodeMissing) => panic!("BUG: source node {:?} or destination node {:?} was not found in the dependency graph", src, dst),
- Err(pie_graph::Error::CycleDetected) => Err(()),
- _ => Ok(()),
- }
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/h_reset.rs b/tutorial/src/2_incrementality/4_store/h_reset.rs
deleted file mode 100644
index 6c0d699..0000000
--- a/tutorial/src/2_incrementality/4_store/h_reset.rs
+++ /dev/null
@@ -1,16 +0,0 @@
-
-impl Store {
- /// Reset task `src`, removing its output and removing all its outgoing dependencies.
- ///
- /// # Panics
- ///
- /// Panics if task `src` was not found in the dependency graph.
- pub fn reset_task(&mut self, src: &TaskNode) {
- if let Some(NodeData::Task { output, .. }) = self.graph.get_node_data_mut(src) {
- *output = None;
- } else {
- panic!("BUG: node {:?} was not found in the dependency graph", src);
- }
- self.graph.remove_outgoing_edges_of_node(src);
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/i_test_file_mapping.rs b/tutorial/src/2_incrementality/4_store/i_test_file_mapping.rs
deleted file mode 100644
index 6cdbabe..0000000
--- a/tutorial/src/2_incrementality/4_store/i_test_file_mapping.rs
+++ /dev/null
@@ -1,50 +0,0 @@
-
-
-#[cfg(test)]
-mod test {
- use crate::Context;
- use crate::stamp::{FileStamper, OutputStamper};
-
- use super::*;
-
- /// Task that returns its owned string. Never executed, just used for testing the store.
- #[derive(Clone, PartialEq, Eq, Hash, Debug)]
- struct StringConstant(String);
-
- impl StringConstant {
- pub fn new(string: impl Into) -> Self { Self(string.into()) }
- }
-
- impl Task for StringConstant {
- type Output = String;
- fn execute>(&self, _context: &mut C) -> Self::Output {
- self.0.clone()
- }
- }
-
- #[test]
- fn test_file_mapping() {
- let mut store: Store = Store::default();
-
- let path_a = PathBuf::from("hello.txt");
- let node_a = store.get_or_create_file_node(&path_a);
- assert_eq!(node_a, store.get_or_create_file_node(&path_a)); // Same node
- assert_eq!(&path_a, store.get_file_path(&node_a)); // Same file path
-
- let path_b = PathBuf::from("world.txt");
- let node_b = store.get_or_create_file_node(&path_b);
- assert_eq!(node_b, store.get_or_create_file_node(&path_b));
- assert_eq!(&path_b, store.get_file_path(&node_b));
-
- assert_ne!(node_a, node_b); // Different nodes
- }
-
- #[test]
- #[should_panic]
- fn test_file_mapping_panics() {
- let mut fake_store: Store = Store::default();
- let fake_node = fake_store.get_or_create_file_node("hello.txt");
- let store: Store = Store::default();
- store.get_file_path(&fake_node);
- }
-}
diff --git a/tutorial/src/2_incrementality/4_store/index.md b/tutorial/src/2_incrementality/4_store/index.md
deleted file mode 100644
index 665d6c9..0000000
--- a/tutorial/src/2_incrementality/4_store/index.md
+++ /dev/null
@@ -1,288 +0,0 @@
-# Dependency Graph Store
-
-To do incremental building, we need to keep track of all files, tasks, their dependencies, and task outputs, in a dependency graph.
-This will be the responsibility of the `Store` data structure.
-Context implementations will use methods on `Store` to query and mutate the dependency graph.
-In other words, `Store` encapsulates the dependency graph.
-
-However, writing a dependency graph data structure is outside of the scope of this tutorial, so we will be using the `pie_graph` library which we prepared exactly for this use case.
-The graph from this library is a directed acyclic graph (DAG), meaning that edges are directed and there may be no cycles in edges, as that would prohibit topological orderings.
-
-```admonish tip title="Graph Library" collapsible=true
-The `pie_graph` library is a modified version of the great [`incremental-topo`](https://github.com/declanvk/incremental-topo/) library which implements incremental topological ordering: it keeps the topological ordering up-to-date incrementally while nodes and edges are added and removed.
-That is exactly what we need, as dynamic dependencies prevents us from calculating the topological ordering in one go, and calculating the topological ordering after every task execution is prohibitively expensive.
-The implementation in the `incremental-topo` library is based on a [paper by D. J. Pearce and P. H. J. Kelly](http://www.doc.ic.ac.uk/~phjk/Publications/DynamicTopoSortAlg-JEA-07.pdf) that describes several dynamic topological sort algorithms for directed acyclic graphs.
-```
-
-Add the `pie_graph` dependency to `pie/Cargo.toml`:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/4_store/a_Cargo.toml.diff
-```
-
-## Store basics
-
-Add the `store` module to `pie/src/lib.rs`:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/4_store/b_module.rs.diff
-```
-
-This module is private, as users of the library should not interact with the store.
-Only `Context` implementations will use the store.
-
-Create the `pie/src/store.rs` file and add the following to get started:
-
-```rust,
-{{#include c_basic.rs}}
-```
-
-The `Store` is generic over tasks `T` and their outputs `O`, like we have done before with `Dependency`.
-
-The `DAG` type from `pie_graph` represents a DAG with nodes and edges, and data attached to those nodes and edges.
-The nodes in our graph are either files or tasks, and the edges are dependencies.
-
-The first generic argument to `DAG` is the type of data to attach to nodes, which is `NodeData` in our case.
-Because nodes can be files or tasks, `NodeData` enumerates these, storing the path for files, and the task along with its output for tasks.
-We store file paths as `PathBuf`, which is the owned version of `Path` (similar to `String` being the owned version of `str`).
-The task output is stored as `Option` because we can add a task to the graph without having executed it, so we don't have its output yet.
-
-The second argument is the type of data to attach to edges, which is `Dependency`, using the `Dependency` enum we defined earlier.
-
-We implement `Default` for the store to initialize it.
-
-```admonish question title="Why not Derive Default?" collapsible=true
-We cannot derive this `Default` implementation even though it seems we should be able to, because the derived implementation will require `T` and `O` to be `Default`, and this is not always the case.
-This is because the `Default` derive macro is conservative and adds a `: Default` bound to *every* generic argument in the `Default` trait implementation, and there is no way to disable this behaviour.
-Therefore, we implement `Default` ourselves.
-
-There are several crates that have more configurable derive macros for these things, but adding an extra dependency to generate a few lines of code is not worth the extra compilation time, so we just implement it manually here.
-```
-
-## Graph nodes
-
-A node in `DAG` is represented by a `Node`, which is a transparent identifier (sometimes called a [handle](https://en.wikipedia.org/wiki/Handle_(computing))) that points to the node and its data.
-We can create nodes in the graph, and then query attached data (`NodeData`) given a node.
-So `DAG` allows us to go from `Node` to a `PathBuf` and task `T` through attached `NodeData`.
-
-However, we want each unique file and task to be represented by a single unique node in the graph.
-We need this for incrementality so that if the build system encounters the same task twice, we can find the corresponding task node in the graph the second time, check if it is consistent, and return its output if it is.
-
-To ensure unique nodes, we need to maintain the reverse mapping from `PathBuf` and `T` to `Node` ourselves, which we will do with `HashMap`s.
-This is also the reason for the `Eq` and `Hash` trait bounds on the `Task` trait, so we can use them as keys in `HashMap`s.
-
-Change `pie/src/store.rs` to add hash maps to map between these things:
-
-```diff2html fromfile linebyline
-../../gen/2_incrementality/4_store/d1_mapping_diff.rs.diff
-```
-
-To prevent accidentally using a file node as a task node, and vice versa, change `pie/src/store.rs` to add specific types of nodes:
-
-```diff2html fromfile
-../../gen/2_incrementality/4_store/d2_mapping_diff.rs.diff
-```
-
-The `FileNode` and `TaskNode` types are [newtypes](https://rust-unofficial.github.io/patterns/patterns/behavioural/newtype.html) that wrap a `Node` into a specific type of node.
-The `Borrow` implementations will make subsequent code a bit more concise by automatically converting `&FileNode` and `&TaskNode`s to `&Node`s.
-
-```admonish question title="Do these Newtypes Improve Type-Safety?" collapsible=true
-Because the `Node`s inside the newtypes are not public, it is not possible to construct a `FileNode` or `TaskNode` outside of this module.
-Therefore, if we only accept and create `FileNode` and `TaskNode` in the `Store` API, it is not possible to use the wrong kind of node, increasing type-safety.
-
-The `Borrow` implementation does leak outside of this module, but not outside of this crate (library).
-This is because the visibility of a trait implementation is the intersection of the visibilities of the trait and type it is implemented on.
-`Borrow` is public, but `FileNode` and `TaskNode` are only public within this crate.
-Thefore, modules of this crate can extract the `Node` out of `FileNode` and `TaskNode`.
-However, that `Node` cannot be used to construct a `FileNode` or `TaskNode`, so it is not a problem.
-```
-
-Now we will add methods create nodes and to query their attached data.
-Add the following code to `pie/src/store.rs`:
-
-```rust,
-{{#include e_mapping.rs:2:}}
-```
-
-The `get_or_create_file_node` method creates file nodes.
-When we want to go from a file path (using `impl AsRef`) to a `FileNode`, either we have already added this file path to the graph and want to get the `FileNode` for it, or we have not yet added it to the graph yet and should add it.
-The former is handled by the if branch in `get_or_create_file_node`, where we just retrieve the `FileNode` from the `file_to_node` hash map.
-The latter is handled by the else branch where we add the node to the graph with `graph.add_node` which attaches the `NodeData::File` data to the node, and then returns a `FileNode` which we insert into the `file_to_node` map.
-
-The `get_file_path` method does the inverse.
-We get the attached data given a node, and extract the file path from it.
-
-Note that we are using `panic!` here to indicate that invalid usage of this method is an *unrecoverable programming error* that should not occur.
-Returning an `Option<&PathBuf>` makes no sense here, as the caller of this method has no way to recover from this.
-Because this is not an end-user-facing API (`store` module is private), we control all the calls to this method, and thus we are responsible for using these methods in a valid way.
-Therefore, when we call these methods, we should document why it is valid (if this is not immediately obvious), and we need to test whether we really use it in a valid way.
-
-We're also documenting the panics in a `# Panics` section in the documentation comment, as is common practice in Rust.
-
-```admonish question title="How to Trigger these Panics?" collapsible=true
-Because only `Store` can create `FileNode`s and `TaskNode`s, and all methods only take these values as inputs, these panics will not happen under normal usage.
-The only way to trigger these panics (in safe Rust) would be to create two stores, and use the nodes from one store in another.
-However, since this is a private module, we just need to make sure that we don't do that.
-
-There are some tricks to prevent even this kind of invalid usage.
-For example, the [generativity](https://docs.rs/generativity/latest/generativity/) crate generates unique identifiers based on lifetimes.
-However, that is a bit overkill, especially for an internal API, so we won't be using that.
-```
-
-We implement similar methods for task nodes in `get_or_create_task_node` and `get_task`.
-
-## Task outputs
-
-When we do not need to execute a task because it is consistent, we still need to return its output.
-Therefore, we store the task output in `NodeData::Task` and add methods to query and manipulate task outputs.
-Add the following code to `pie/src/store.rs`:
-
-```rust,
-{{#include f_output.rs:2:}}
-```
-
-The `task_has_output`, `get_task_output`, and `set_task_output` methods manipulate task outputs in `NodeData::Task`.
-
-Again, we are using panics here to indicate unrecoverable programming errors.
-
-## Dependencies
-
-Now we need methods to query and manipulate dependencies.
-The edges in the graph are dependencies between tasks and files.
-Tasks can depend on other tasks and files, but there are no dependencies between files.
-An edge does not have its own dedicated representation, and is simply represented by two nodes: the source node and the destination node of the edge.
-
-Add the following code to `pie/src/store.rs`:
-
-```rust,
-{{#include g_dependency.rs:2:}}
-```
-
-The `get_dependencies_of_task` method gets the dependencies (edge data of outgoing edges) of a task, and returns it as an iterator (which is empty if task has no dependencies).
-This method needs explicit lifetime annotations due to the signature of `get_outgoing_edge_data` and the way we return an iterator using `impl Iterator<...`.
-We're using `debug_assert!` here to trigger a panic indicating an unrecoverable programming error only in development mode, because this check is too expensive to run in release (optimized) mode.
-
-The `add_file_require_dependency` method adds a file dependency.
-Adding an edge to the graph can result in cycles, which are not allowed in a directed *acyclic* graph (DAG).
-Therefore, `graph.add_edge` can return an `Err` indicating that there is a cycle.
-In case of files, this cannot happen because files do not have outgoing dependencies, and the API enforces this by never taking a `FileNode` as a source (`src`) of an edge.
-
-Tasks can depend on other tasks, so they can create cycles.
-In `add_task_require_dependency`, we propagate the cycle detected error (by returning `Err(())`) to the caller because the caller has more information to create an error message for the user that made a cyclic task dependency.
-
-[//]: # (We want to catch those cycles not just because they are not allowed in a DAG, but because cycles between tasks could result in cyclic task execution, causing builds to infinitely execute.)
-
-[//]: # ()
-[//]: # (When a task requires another task, we need to add an edge to the dependency graph to check if this edge creates a cycle, but also to have this edge in the dependency graph for future cycle detection.)
-
-[//]: # (However, at the moment we require the task, we do not yet have an output for the task, as we only get an output after we've executed the task.)
-
-[//]: # (Therefore, we first *reserve* the task dependency, and then update it with an output.)
-
-[//]: # (This manifests itself as the attached edge data being `Option>`, where `None` indicates that the dependency has been reserved.)
-
-[//]: # ()
-[//]: # (The `reserve_task_require_dependency` and `update_reserved_task_require_dependency` methods implement this behavior.)
-
-[//]: # (We propagate cycle errors so that the caller can report an error message.)
-
-## Resetting tasks
-
-Finally, when we determine that a task is inconsistent and needs to be executed, we first need to remove its output and remove its outgoing dependencies, as those will interfere with incrementality when not removed.
-We do NOT want to remove incoming dependencies, as that would remove dependencies from other tasks to this task, which breaks incrementality, so we can't just remove and re-add the task to the graph.
-Add the `reset_task` method that does this to `pie/src/store.rs`:
-
-```rust,
-{{#include h_reset.rs:2:}}
-```
-
-This will reset the task output back to `None`, and remove all outgoing edges (dependencies).
-
-## Tests
-
-Now we've implemented everything we need for implementing the top-down context, but first we will write some tests.
-
-### Testing file mapping
-
-Add the following code to `pie/src/store.rs` for testing the file mapping:
-
-```rust,
-{{#include i_test_file_mapping.rs:3:}}
-```
-
-We create a simple task `StringConstant` because we need a `Task` implementation to test `Store`, as `Store` is generic over a `Task` type.
-We will never execute it because `Store` does not execute tasks.
-
-Test `test_file_mapping` checks whether the file node mapping works as expected:
-- `get_or_create_file_node` calls with the same path should produce the same `FileNode`.
-- `get_or_create_file_node` calls with different paths should produce different `FileNode`s.
-
-This works because `"hello.txt"` and `"world.txt"` are different paths, thus their `Eq` and `Hash` implementations ensure they get separate spots in the `file_to_node` hash map.
-
-Test `test_file_mapping_panics` triggers the panic in `get_file_path` by creating a `FileNode` with a "fake store", and then using that rogue file node in another store.
-While it is unlikely that we will make this mistake when using `Store`, it is good to confirm that this panics.
-
-```admonish tip title="Rust Help: Testing Panics" collapsible=true
-The `#[should_panic]` attribute makes the test succeed if it panics, and fail if it does not panic.
-```
-
-### Testing task mapping
-
-Test the task mapping by inserting the following code into the `test` module (before the last `}`):
-
-```rust,
-{{#include j_test_task_mapping.rs:3:}}
-```
-
-We test this in the same way as the file mapping.
-Again, this works because `StringConstant("Hello")` and `StringConstant("World")` are different due to their derived `Eq` and `Hash` implementations, which make them different due to the strings being different.
-Likewise, `StringConstant::new("Hello")` and `StringConstant::new("Hello")` are equal even if they are created with 2 separate invocations of `new`.
-
-These (in)equalities might seem quite obvious, but it is important to keep in mind because incrementality can only work if we can identify equal tasks at a later time, so that we can check their dependencies and return their cached output when those dependencies are consistent.
-Later on we will also see that this is important for soundness of the incremental build system.
-
-### Testing task outputs
-
-Test task outputs by inserting the following code into the `test` module:
-
-```rust,
-{{#include k_test_task_output.rs:3:}}
-```
-
-Test `test_task_outputs` ensures that:
-- `task_has_output` only returns true if given task has an output,
-- and that `get_task_output` returns the output set by `set_task_output` for given task.
-
-Test `test_get_task_output_panics` triggers a panic when we call `get_task_output` for a task that has no output, which is an invalid usage of `Store` that is more likely to happen than the other panics.
-
-### Testing dependencies
-
-Test dependencies by inserting the following code into the `test` module:
-
-```rust,
-{{#include l_test_dependencies.rs:3:}}
-```
-
-The `test_dependencies` test is a bit more involved because it ensures that:
-- `get_dependencies_of_task` returns the dependencies of given task. If the task has no dependencies, the iterator is empty. We test if an iterator is empty by getting the first element of the iterator with `.next()` and assert that it is `None`.
-- `get_dependencies_of_task` returns the dependencies of given task in the order in which they were added, which will be important for soundness later. The graph library returns dependencies in insertion order.
-- `add_task_require_dependency` adds a dependency to the correct task.
-- creating a cycle with `add_task_require_dependency` results in it returning `Err(())`.
-
-Note that the `StringConstant` task does not actually create file or task dependencies, but since `Store` never executes a task, we can pretend that it does in tests.
-
-### Testing task reset
-
-Finally, test task reset by inserting the following code into the `test` module:
-
-```rust,
-{{#include m_test_reset.rs:3:}}
-```
-
-Here, we ensure that a task with an output and dependencies, does not have an output and dependencies after a reset, while leaving another task untouched.
-
-Confirm that the store implementation works with `cargo test`.
-
-```admonish example title="Download source code" collapsible=true
-You can [download the source files up to this point](../../gen/2_incrementality/4_store/source.zip).
-```
diff --git a/tutorial/src/2_incrementality/4_store/j_test_task_mapping.rs b/tutorial/src/2_incrementality/4_store/j_test_task_mapping.rs
deleted file mode 100644
index d4036f1..0000000
--- a/tutorial/src/2_incrementality/4_store/j_test_task_mapping.rs
+++ /dev/null
@@ -1,27 +0,0 @@
-
-
- #[test]
- fn test_task_mapping() {
- let mut store = Store::default();
-
- let task_a = StringConstant::new("Hello");
- let node_a = store.get_or_create_task_node(&task_a);
- assert_eq!(node_a, store.get_or_create_task_node(&task_a)); // Same node
- assert_eq!(&task_a, store.get_task(&node_a)); // Same task
-
- let task_b = StringConstant::new("World");
- let node_b = store.get_or_create_task_node(&task_b);
- assert_eq!(node_b, store.get_or_create_task_node(&task_b));
- assert_eq!(&task_b, store.get_task(&node_b));
-
- assert_ne!(node_a, node_b); // Different nodes
- }
-
- #[test]
- #[should_panic]
- fn test_task_mapping_panics() {
- let mut fake_store = Store::default();
- let fake_node = fake_store.get_or_create_task_node(&StringConstant::new("Hello"));
- let store: Store = Store::default();
- store.get_task(&fake_node);
- }
diff --git a/tutorial/src/2_incrementality/4_store/k_test_task_output.rs b/tutorial/src/2_incrementality/4_store/k_test_task_output.rs
deleted file mode 100644
index 1444f4c..0000000
--- a/tutorial/src/2_incrementality/4_store/k_test_task_output.rs
+++ /dev/null
@@ -1,56 +0,0 @@
-
-
- #[test]
- fn test_task_outputs() {
- let mut store = Store::default();
- let output_a = "Hello".to_string();
- let task_a = StringConstant::new(&output_a);
- let node_a = store.get_or_create_task_node(&task_a);
-
- let output_b = "World".to_string();
- let task_b = StringConstant::new(&output_b);
- let node_b = store.get_or_create_task_node(&task_b);
-
- // Assert that tasks have no output by default.
- assert!(!store.task_has_output(&node_a));
- assert!(!store.task_has_output(&node_b));
-
- // Set output for task A, assert that A has that output but B is unchanged.
- store.set_task_output(&node_a, output_a.clone());
- assert!(store.task_has_output(&node_a));
- assert_eq!(store.get_task_output(&node_a), &output_a);
- assert!(!store.task_has_output(&node_b));
-
- // Set output for task B, assert that B has that output but A is unchanged.
- store.set_task_output(&node_b, output_b.clone());
- assert!(store.task_has_output(&node_a));
- assert_eq!(store.get_task_output(&node_a), &output_a);
- assert!(store.task_has_output(&node_b));
- assert_eq!(store.get_task_output(&node_b), &output_b);
- }
-
- #[test]
- #[should_panic]
- fn test_task_has_output_panics() {
- let mut fake_store = Store::default();
- let fake_node = fake_store.get_or_create_task_node(&StringConstant::new("Hello"));
- let store: Store = Store::default();
- store.task_has_output(&fake_node);
- }
-
- #[test]
- #[should_panic]
- fn test_get_task_output_panics() {
- let mut store = Store::default();
- let node = store.get_or_create_task_node(&StringConstant::new("Hello"));
- store.get_task_output(&node);
- }
-
- #[test]
- #[should_panic]
- fn test_set_task_output_panics() {
- let mut fake_store = Store::default();
- let fake_node = fake_store.get_or_create_task_node(&StringConstant::new("Hello"));
- let mut store: Store = Store::default();
- store.set_task_output(&fake_node, "Hello".to_string());
- }
diff --git a/tutorial/src/2_incrementality/4_store/l_test_dependencies.rs b/tutorial/src/2_incrementality/4_store/l_test_dependencies.rs
deleted file mode 100644
index 61fa73d..0000000
--- a/tutorial/src/2_incrementality/4_store/l_test_dependencies.rs
+++ /dev/null
@@ -1,84 +0,0 @@
-
-
- #[test]
- fn test_dependencies() {
- let mut store = Store::default();
- let output_a = "Hello".to_string();
- let task_a = StringConstant::new(output_a.clone());
- let node_a = store.get_or_create_task_node(&task_a);
- let output_b = "World".to_string();
- let task_b = StringConstant::new(output_b.clone());
- let node_b = store.get_or_create_task_node(&task_b);
- let path_c = PathBuf::from("hello.txt");
- let node_c = store.get_or_create_file_node(&path_c);
-
- assert_eq!(store.get_dependencies_of_task(&node_a).next(), None);
- assert_eq!(store.get_dependencies_of_task(&node_b).next(), None);
-
- // Add file dependency from task A to file C.
- let file_dependency_a2c = FileDependency::new(&path_c, FileStamper::Exists).unwrap();
- store.add_file_require_dependency(&node_a, &node_c, file_dependency_a2c.clone());
- let deps_of_a: Vec<_> = store.get_dependencies_of_task(&node_a).cloned().collect();
- assert_eq!(deps_of_a.get(0), Some(&Dependency::RequireFile(file_dependency_a2c.clone())));
- assert_eq!(deps_of_a.get(1), None);
- assert_eq!(store.get_dependencies_of_task(&node_b).next(), None);
-
- // Add task dependency from task B to task A.
- let task_dependency_b2a = TaskDependency::new(task_a.clone(), OutputStamper::Equals, output_a.clone());
- let result = store.add_task_require_dependency(&node_b, &node_a, task_dependency_b2a.clone());
- assert_eq!(result, Ok(()));
- let deps_of_a: Vec<_> = store.get_dependencies_of_task(&node_a).cloned().collect();
- assert_eq!(deps_of_a.get(0), Some(&Dependency::RequireFile(file_dependency_a2c.clone())));
- assert_eq!(deps_of_a.get(1), None);
- let deps_of_b: Vec<_> = store.get_dependencies_of_task(&node_b).cloned().collect();
- assert_eq!(deps_of_b.get(0), Some(&Dependency::RequireTask(task_dependency_b2a.clone())));
- assert_eq!(deps_of_b.get(1), None);
-
- // Add file dependency from task B to file C.
- let file_dependency_b2c = FileDependency::new(&path_c, FileStamper::Exists).unwrap();
- store.add_file_require_dependency(&node_b, &node_c, file_dependency_b2c.clone());
- let deps_of_a: Vec<_> = store.get_dependencies_of_task(&node_a).cloned().collect();
- assert_eq!(deps_of_a.get(0), Some(&Dependency::RequireFile(file_dependency_a2c.clone())));
- assert_eq!(deps_of_a.get(1), None);
- let deps_of_b: Vec<_> = store.get_dependencies_of_task(&node_b).cloned().collect();
- assert_eq!(deps_of_b.get(0), Some(&Dependency::RequireTask(task_dependency_b2a.clone())));
- assert_eq!(deps_of_b.get(1), Some(&Dependency::RequireFile(file_dependency_b2c.clone())));
- assert_eq!(deps_of_b.get(2), None);
-
- // Add task dependency from task A to task B, creating a cycle.
- let task_dependency_a2b = TaskDependency::new(task_a.clone(), OutputStamper::Equals, output_a.clone());
- let result = store.add_task_require_dependency(&node_a, &node_b, task_dependency_a2b);
- assert_eq!(result, Err(())); // Creates a cycle: error
- }
-
- #[test]
- #[should_panic]
- fn test_get_dependencies_of_task_panics() {
- let mut fake_store = Store::default();
- let fake_node = fake_store.get_or_create_task_node(&StringConstant::new("Hello"));
- let store: Store = Store::default();
- let _ = store.get_dependencies_of_task(&fake_node);
- }
-
- #[test]
- #[should_panic]
- fn test_add_file_require_dependency_panics() {
- let mut fake_store = Store::default();
- let fake_file_node = fake_store.get_or_create_file_node("hello.txt");
- let fake_task_node = fake_store.get_or_create_task_node(&StringConstant::new("Hello"));
- let mut store: Store = Store::default();
- let dependency = FileDependency::new("hello.txt", FileStamper::Exists).unwrap();
- store.add_file_require_dependency(&fake_task_node, &fake_file_node, dependency);
- }
-
- #[test]
- #[should_panic]
- fn test_add_task_require_dependency_panics() {
- let mut fake_store = Store::default();
- let output = "Hello".to_string();
- let task = StringConstant::new(&output);
- let fake_task_node = fake_store.get_or_create_task_node(&task);
- let mut store: Store = Store::default();
- let dependency = TaskDependency::new(task, OutputStamper::Equals, output);
- let _ = store.add_task_require_dependency(&fake_task_node, &fake_task_node, dependency);
- }
diff --git a/tutorial/src/2_incrementality/4_store/m_test_reset.rs b/tutorial/src/2_incrementality/4_store/m_test_reset.rs
deleted file mode 100644
index 45f72a4..0000000
--- a/tutorial/src/2_incrementality/4_store/m_test_reset.rs
+++ /dev/null
@@ -1,54 +0,0 @@
-
-
- #[test]
- fn test_reset() {
- let mut store = Store::default();
- let output_a = "Hello".to_string();
- let task_a = StringConstant::new(output_a.clone());
- let task_a_node = store.get_or_create_task_node(&task_a);
- let output_b = "World".to_string();
- let task_b = StringConstant::new(output_b.clone());
- let task_b_node = store.get_or_create_task_node(&task_b);
- let path = PathBuf::from("hello.txt");
- let file_node = store.get_or_create_file_node(&path);
-
- // Set outputs for task A and B.
- store.set_task_output(&task_a_node, output_a.clone());
- assert!(store.task_has_output(&task_a_node));
- assert_eq!(store.get_task_output(&task_a_node), &output_a);
- store.set_task_output(&task_b_node, output_b.clone());
- assert!(store.task_has_output(&task_b_node));
- assert_eq!(store.get_task_output(&task_b_node), &output_b);
-
- // Add file dependency for task A and B.
- let file_dependency = FileDependency::new(&path, FileStamper::Exists).unwrap();
- store.add_file_require_dependency(&task_a_node, &file_node, file_dependency.clone());
- let deps_of_a: Vec<_> = store.get_dependencies_of_task(&task_a_node).cloned().collect();
- assert_eq!(deps_of_a.get(0), Some(&Dependency::RequireFile(file_dependency.clone())));
- assert_eq!(deps_of_a.get(1), None);
- store.add_file_require_dependency(&task_b_node, &file_node, file_dependency.clone());
- let deps_of_b: Vec<_> = store.get_dependencies_of_task(&task_b_node).cloned().collect();
- assert_eq!(deps_of_b.get(0), Some(&Dependency::RequireFile(file_dependency.clone())));
- assert_eq!(deps_of_b.get(1), None);
-
- // Reset only task A.
- store.reset_task(&task_a_node);
- // Assert that task A is reset.
- assert!(!store.task_has_output(&task_a_node));
- assert_eq!(store.get_dependencies_of_task(&task_a_node).next(), None);
- // Assert that task B is unchanged.
- assert!(store.task_has_output(&task_b_node));
- assert_eq!(store.get_task_output(&task_b_node), &output_b);
- let deps_of_b: Vec<_> = store.get_dependencies_of_task(&task_b_node).cloned().collect();
- assert_eq!(deps_of_b.get(0), Some(&Dependency::RequireFile(file_dependency.clone())));
- assert_eq!(deps_of_b.get(1), None);
- }
-
- #[test]
- #[should_panic]
- fn test_reset_task_panics() {
- let mut fake_store = Store::default();
- let fake_node = fake_store.get_or_create_task_node(&StringConstant::new("Hello"));
- let mut store: Store = Store::default();
- store.reset_task(&fake_node);
- }
diff --git a/tutorial/src/2_incrementality/5_context/a_module.rs b/tutorial/src/2_incrementality/5_context/a_module.rs
deleted file mode 100644
index df56421..0000000
--- a/tutorial/src/2_incrementality/5_context/a_module.rs
+++ /dev/null
@@ -1,2 +0,0 @@
-pub mod non_incremental;
-pub mod top_down;
diff --git a/tutorial/src/2_incrementality/5_context/b_basic.rs b/tutorial/src/2_incrementality/5_context/b_basic.rs
deleted file mode 100644
index 762d3b8..0000000
--- a/tutorial/src/2_incrementality/5_context/b_basic.rs
+++ /dev/null
@@ -1,30 +0,0 @@
-use std::fs::File;
-use std::io;
-use std::path::Path;
-
-use crate::{Context, fs, Task};
-use crate::dependency::{FileDependency, TaskDependency};
-use crate::stamp::{FileStamper, OutputStamper};
-use crate::store::{Store, TaskNode};
-
-pub struct TopDownContext {
- store: Store,
-}
-
-impl TopDownContext {
- pub fn new() -> Self {
- Self {
- store: Store::default(),
- }
- }
-}
-
-impl Context for TopDownContext {
- fn require_file_with_stamper>(&mut self, path: P, stamper: FileStamper) -> Result, io::Error> {
- todo!()
- }
-
- fn require_task_with_stamper(&mut self, task: &T, stamper: OutputStamper) -> T::Output {
- todo!()
- }
-}
diff --git a/tutorial/src/2_incrementality/5_context/c_current.rs b/tutorial/src/2_incrementality/5_context/c_current.rs
deleted file mode 100644
index 0fe4d46..0000000
--- a/tutorial/src/2_incrementality/5_context/c_current.rs
+++ /dev/null
@@ -1,35 +0,0 @@
-use std::fs::File;
-use std::io;
-use std::path::Path;
-
-use crate::{Context, fs, Task};
-use crate::dependency::{FileDependency, TaskDependency};
-use crate::stamp::{FileStamper, OutputStamper};
-use crate::store::{Store, TaskNode};
-
-pub struct TopDownContext {
- store: Store,
- current_executing_task: Option,
-}
-
-impl TopDownContext {
- pub fn new() -> Self {
- Self {
- store: Store::default(),
- current_executing_task: None,
- }
- }
-}
-
-impl Context for TopDownContext {
- fn require_file_with_stamper>(&mut self, path: P, stamper: FileStamper) -> Result, io::Error> {
- let Some(current_executing_task_node) = &self.current_executing_task else {
- return fs::open_if_file(path); // No current executing task, so no dependency needs to be made.
- };
- todo!()
- }
-
- fn require_task_with_stamper(&mut self, task: &T, stamper: OutputStamper) -> T::Output {
- todo!()
- }
-}
diff --git a/tutorial/src/2_incrementality/5_context/d_file.rs b/tutorial/src/2_incrementality/5_context/d_file.rs
deleted file mode 100644
index 1920441..0000000
--- a/tutorial/src/2_incrementality/5_context/d_file.rs
+++ /dev/null
@@ -1,39 +0,0 @@
-use std::fs::File;
-use std::io;
-use std::path::Path;
-
-use crate::{Context, fs, Task};
-use crate::dependency::{FileDependency, TaskDependency};
-use crate::stamp::{FileStamper, OutputStamper};
-use crate::store::{Store, TaskNode};
-
-pub struct TopDownContext {
- store: Store,
- current_executing_task: Option,
-}
-
-impl